Skip to main content
API docs by Redocly

MilMove GHC API (0.0.1)

Download OpenAPI specification:Download

E-mail: milmove-developers@caci.com License: MIT

The GHC API is a RESTful API that enables the Office application for MilMove.

All endpoints are located under /ghc/v1.

queues

Gets queued list of all customer moves needing services counseling by GBLOC origin

An office services counselor user will be assigned a transportation office that will determine which moves are displayed in their queue based on the origin duty location. GHC moves will show up here onced they have reached the NEEDS SERVICE COUNSELING status after submission from a customer or created on a customer's behalf.

query Parameters
page
integer

requested page number of paginated move results

perPage
integer

maximum number of moves to show on each page of paginated results

sort
string
Enum: "customerName" "edipi" "emplid" "branch" "locator" "status" "requestedMoveDate" "submittedAt" "originGBLOC" "originDutyLocation" "destinationDutyLocation" "ppmType" "closeoutInitiated" "closeoutLocation" "ppmStatus" "counselingOffice" "assignedTo"

field that results should be sorted by

order
string
Enum: "asc" "desc"

direction of sort order if applied

branch
string

filters by the branch of the move's service member

locator
string

filters to match the unique move code locator

customerName
string

filters using a prefix match on the service member's last name

counselingOffice
string

filters using a counselingOffice name of the move

edipi
string

filters to match the unique service member's DoD ID

emplid
string

filters to match the unique service member's EMPLID

requestedMoveDate
string

filters the requested pickup date of a shipment on the move

submittedAt
string <date-time>

Start of the submitted at date in the user's local time zone converted to UTC

originGBLOC
string

filters the GBLOC of the service member's origin duty location

originDutyLocation
Array of strings unique

filters the name of the origin duty location on the orders

destinationDutyLocation
string

filters the name of the destination duty location on the orders

status
Array of strings unique
Items Enum: "NEEDS SERVICE COUNSELING" "SERVICE COUNSELING COMPLETED"

filters the status of the move

needsPPMCloseout
boolean

Only used for Services Counseling queue. If true, show PPM moves that are ready for closeout. Otherwise, show all other moves.

ppmType
string
Enum: "FULL" "PARTIAL"

filters PPM type

closeoutInitiated
string <date-time>

Latest date that closeout was initiated on a PPM on the move

closeoutLocation
string

closeout location

orderType
string

order type

ppmStatus
string
Enum: "WAITING_ON_CUSTOMER" "NEEDS_CLOSEOUT"

filters the status of the PPM shipment

viewAsGBLOC
string

Used to return a queue for a GBLOC other than the default of the current user. Requires the HQ role or a secondary transportation office assignment. The parameter is ignored if the requesting user does not have the necessary role or assignment.

assignedTo
string

Used to illustrate which user is assigned to this payment request.

activeRole
string

user's actively logged in role

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "totalCount": 0,
  • "queueMoves": [
    ]
}

Gets data for bulk assignment modal

Supervisor office users are able to bulk assign moves. This endpoint returns the relevant data to them; the current workload of the office users that work under them, and the moves that are available to be assigned

query Parameters
queueType
string
Enum: "COUNSELING" "CLOSEOUT" "TASK_ORDER" "PAYMENT_REQUEST" "DESTINATION_REQUESTS"

A string corresponding to the queue type

Responses

Response samples

Content type
application/json
{
  • "availableOfficeUsers": [
    ],
  • "bulkAssignmentMoveIDs": [
    ]
}

Assigns one or more moves to one or more office users

Supervisor office users are able to assign moves. This endpoint saves office user assignments to multiple moves.

Request Body schema: application/json
Array of objects (BulkAssignmentForUser)
moveData
Array of strings <uuid> (BulkAssignmentMoveData)
queueType
string
Enum: "COUNSELING" "CLOSEOUT" "TASK_ORDER" "PAYMENT_REQUEST" "DESTINATION_REQUESTS"

A string corresponding to the queue type

Responses

Request samples

Content type
application/json
{
  • "userData": [
    ],
  • "moveData": [
    ],
  • "queueType": "COUNSELING"
}

Gets queued list of all moves origin locations in the counselors queue

An office services counselor user will be assigned a transportation office that will determine which moves are displayed in their queue based on the origin duty location. This pulls the availalble origin duty locations.

query Parameters
needsPPMCloseout
boolean

Only used for Services Counseling queue. If true, show PPM moves origin locations that are ready for closeout. Otherwise, show all other moves origin locations.

viewAsGBLOC
string

Used to return an origins list for a GBLOC other than the default of the current user. Requires the HQ role or a secondary transportation office assignment. The parameter is ignored if the requesting user does not have the necessary role or assignment.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getPrimeMovesQueue

Gets all moves that have been reviewed and approved by the TOO. The since parameter can be used to filter this list down to only the moves that have been updated since the provided timestamp. A move will be considered updated if the updatedAt timestamp on the move or on its orders, shipments, service items, or payment requests, is later than the provided date and time.

WIP: Include what causes moves to leave this list. Currently, once the availableToPrimeAt timestamp has been set, that move will always appear in this list.

query Parameters
since
string <date-time>

Only return moves updated since this time. Formatted like "2021-07-23T18:30:47.116Z"

page
integer

requested page of results

perPage
integer

results per page

id
string
moveCode
string
orderType
string

order type

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "totalCount": 0,
  • "queueMoves": [
    ]
}

Gets queued list of all customer moves by GBLOC origin

An office TOO user will be assigned a transportation office that will determine which moves are displayed in their queue based on the origin duty location. GHC moves will show up here onced they have reached the submitted status sent by the customer and have move task orders, shipments, and service items to approve.

query Parameters
page
integer

requested page of results

perPage
integer

results per page

sort
string
Enum: "customerName" "edipi" "emplid" "branch" "locator" "status" "originDutyLocation" "destinationDutyLocation" "requestedMoveDate" "appearedInTooAt" "assignedTo" "counselingOffice"

field that results should be sorted by

order
string
Enum: "asc" "desc"

direction of sort order if applied

branch
string
locator
string
customerName
string
edipi
string
emplid
string
originDutyLocation
Array of strings unique
destinationDutyLocation
string
appearedInTooAt
string <date-time>
requestedMoveDate
string

filters the requested pickup date of a shipment on the move

status
Array of strings unique
Items Enum: "SUBMITTED" "SERVICE COUNSELING COMPLETED" "APPROVALS REQUESTED"

Filtering for the status.

orderType
string

order type

viewAsGBLOC
string

Used to return a queue for a GBLOC other than the default of the current user. Requires the HQ role or a secondary transportation office assignment. The parameter is ignored if the requesting user does not have the necessary role or assignment.

assignedTo
string

Used to illustrate which user is assigned to this move.

counselingOffice
string

filters using a counselingOffice name of the move

activeRole
string

user's actively logged in role

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "totalCount": 0,
  • "queueMoves": [
    ]
}

Gets queued list of all customer moves by GBLOC that have both CONUS & OCONUS destination requests (destination SIT, destination shuttle, address requests)

A TOO will view this queue when they have destination requests tied to their GBLOC. This includes unapproved destination SIT service items, destination shuttle service items and destination address requests that are not yet approved by the TOO.

query Parameters
page
integer

requested page of results

perPage
integer

results per page

sort
string
Enum: "customerName" "edipi" "emplid" "branch" "locator" "status" "originDutyLocation" "destinationDutyLocation" "requestedMoveDate" "appearedInTooAt" "assignedTo" "counselingOffice"

field that results should be sorted by

order
string
Enum: "asc" "desc"

direction of sort order if applied

branch
string
locator
string
customerName
string
edipi
string
emplid
string
originDutyLocation
Array of strings unique
destinationDutyLocation
string
appearedInTooAt
string <date-time>
requestedMoveDate
string

filters the requested pickup date of a shipment on the move

status
Array of strings unique
Items Enum: "SUBMITTED" "SERVICE COUNSELING COMPLETED" "APPROVALS REQUESTED"

Filtering for the status.

viewAsGBLOC
string

Used to return a queue for a GBLOC other than the default of the current user. Requires the HQ role or a secondary transportation office assignment. The parameter is ignored if the requesting user does not have the necessary role or assignment.

assignedTo
string

Used to illustrate which user is assigned to this move.

counselingOffice
string

filters using a counselingOffice name of the move

activeRole
string

user's actively logged in role.

orderType
string

order type

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "totalCount": 0,
  • "queueMoves": [
    ]
}

Gets queued list of all payment requests by GBLOC origin

An office TIO user will be assigned a transportation office that will determine which payment requests are displayed in their queue based on the origin duty location.

query Parameters
sort
string
Enum: "customerName" "locator" "submittedAt" "branch" "status" "edipi" "emplid" "age" "originDutyLocation" "assignedTo" "counselingOffice"

field that results should be sorted by

order
string
Enum: "asc" "desc"

direction of sort order if applied

page
integer

requested page of results

perPage
integer

number of records to include per page

submittedAt
string <date-time>

Start of the submitted at date in the user's local time zone converted to UTC

branch
string
locator
string
customerName
string
edipi
string
emplid
string
destinationDutyLocation
string
originDutyLocation
string
assignedTo
string

Used to illustrate which user is assigned to this payment request.

counselingOffice
string

filters using a counselingOffice name of the move

status
Array of strings unique
Items Enum: "PENDING" "REVIEWED" "REVIEWED_AND_ALL_SERVICE_ITEMS_REJECTED" "PAID" "DEPRECATED" "EDI_ERROR"

Filtering for the status.

orderType
string

order type

viewAsGBLOC
string

Used to return a queue for a GBLOC other than the default of the current user. Requires the HQ role or a secondary transportation office assignment. The parameter is ignored if the requesting user does not have the necessary role or assignment.

activeRole
string

user's actively logged in role

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "totalCount": 0,
  • "queuePaymentRequests": [
    ]
}

move

Returns a given move

Returns a given move for a unique alphanumeric locator string

path Parameters
locator
required
string

Code used to identify a move in the system

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Returns the history of an identified move

Returns the history for a given move for a unique alphanumeric locator string

path Parameters
locator
required
string

Code used to identify a move in the system

query Parameters
page
integer

requested page of results

perPage
integer

results per page

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "totalCount": 0,
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "historyRecords": [
    ],
  • "locator": "1K43AR",
  • "referenceId": "1001-3456"
}

Returns shipment evaluation reports for the specified move that are visible to the current office user

Returns shipment evaluation reports for the specified move that are visible to the current office user

path Parameters
moveID
required
string <uuid>

Code used to identify a move in the system

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns counseling evaluation reports for the specified move that are visible to the current office user

Returns counseling evaluation reports for the specified move that are visible to the current office user

path Parameters
moveID
required
string <uuid>

Code used to identify a move in the system

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cancels a move

cancels a move

path Parameters
moveID
required
string <uuid>

ID of the move

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Updates a Move's PPM closeout office for Army and Air Force customers

Sets the transportation office closeout location for where the Move's PPM Shipment documentation will be reviewed by

path Parameters
locator
required
string <string>

move code to identify a move to update the PPM shipment's closeout office for Army and Air Force service members

header Parameters
If-Match
required
string
Request Body schema: application/json
closeoutOfficeId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2"
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Flags a move for financial office review

This sets a flag which indicates that the move should be reviewed by a fincancial office. For example, if the origin or delivery address of a shipment is far from the duty location and may incur excess costs to the customer.

path Parameters
moveID
required
string <uuid>

ID of move to flag

header Parameters
If-Match
string
Request Body schema: application/json
remarks
string or null

explanation of why the move is being flagged for financial review

flagForReview
required
boolean

boolean value representing whether we should flag a move for financial review

Responses

Request samples

Content type
application/json
{
  • "remarks": "this address is way too far away",
  • "flagForReview": false
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Patch the additional documents for a given move

Customers will on occaision need the ability to upload additional supporting documents, for a variety of reasons. This does not include amended order.

path Parameters
moveID
required
string <uuid>

UUID of the order

Request Body schema: multipart/form-data
file
required
string <binary>

The file to upload.

Responses

Search moves by locator, DOD ID, or customer name

Search moves by locator, DOD ID, or customer name. Used by QAE and CSR users.

Request Body schema: application/json

field that results should be sorted by

page
integer

requested page of results

perPage
integer
locator
string or null = 6 characters

Move locator

edipi
string or null = 10 characters

DOD ID

emplid
string or null = 7 characters

EMPLID

customerName
string or null non-empty

Customer Name

paymentRequestCode
string or null
status
Array of strings unique
Items Enum: "DRAFT" "SUBMITTED" "APPROVALS REQUESTED" "APPROVED" "NEEDS SERVICE COUNSELING" "SERVICE COUNSELING COMPLETED" "CANCELED"

Filtering for the status.

originPostalCode
string or null
destinationPostalCode
string or null
branch
string or null
shipmentsCount
integer or null
pickupDate
string or null <date-time>
deliveryDate
string or null <date-time>
sort
string or null
Enum: "customerName" "edipi" "emplid" "branch" "locator" "status" "originPostalCode" "destinationPostalCode" "shipmentsCount"
order
string or null
Enum: "asc" "desc"

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "locator": "string",
  • "edipi": "stringstri",
  • "emplid": "strings",
  • "customerName": "string",
  • "paymentRequestCode": "9551-6199-2",
  • "status": [
    ],
  • "originPostalCode": "string",
  • "destinationPostalCode": "string",
  • "branch": "string",
  • "shipmentsCount": 0,
  • "pickupDate": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "sort": "customerName",
  • "order": "asc"
}

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "totalCount": 0,
  • "searchMoves": [
    ]
}

updateAssignedOfficeUser

assigns either a services counselor, task ordering officer, or task invoicing officer to the move

path Parameters
moveID
required
string <uuid>

ID of the move

Request Body schema: application/json
officeUserId
required
string <uuid>
queueType
required
string

Responses

Request samples

Content type
application/json
{
  • "officeUserId": "267ccd58-72b9-4cd2-b980-e3719bbf8504",
  • "queueType": "string"
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

deleteAssignedOfficeUser

unassigns either a services counselor, task ordering officer, or task invoicing officer from the move

path Parameters
moveID
required
string <uuid>

ID of the move

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

checkForLockedMovesAndUnlock

Finds and unlocks any locked moves by an office user

path Parameters
officeUserID
required
string <uuid>

ID of the move's officer

Responses

Response samples

Content type
application/json
{
  • "successMessage": "OK"
}

order

Move Orders - Commonly called “Orders,” especially in customer-facing language. Orders are plural because they're a bundle of related orders issued bya Service (e.g. Army, Air Force, Navy) to a customer that authorize (and order) that customer to move from one location to another. Orders are backed by $$ in the bank to support that move, which is identified by a Line of Account (LOA) code on the orders document.

Updates an order (performed by a services counselor)

All fields sent in this request will be set on the order referenced

path Parameters
orderID
required
string <uuid>

ID of order to update

header Parameters
If-Match
required
string
Request Body schema: application/json
issueDate
required
string <date> (Orders date)

The date and time that these orders were cut.

reportByDate
required
string <date> (Report-by date)

Report By Date

ordersType
required
string (Orders type)
Enum: "PERMANENT_CHANGE_OF_STATION" "LOCAL_MOVE" "RETIREMENT" "SEPARATION" "WOUNDED_WARRIOR" "BLUEBARK" "SAFETY" "TEMPORARY_DUTY" "EARLY_RETURN_OF_DEPENDENTS" "STUDENT_TRAVEL"
ordersTypeDetail
string or null (Orders type detail)
Enum: "HHG_PERMITTED" "PCS_TDY" "HHG_RESTRICTED_PROHIBITED" "HHG_RESTRICTED_AREA" "INSTRUCTION_20_WEEKS" "HHG_PROHIBITED_20_WEEKS" "DELAYED_APPROVAL"
ordersNumber
string or null (Orders Number)
departmentIndicator
string or null (Dept. indicator)
Enum: "NAVY_AND_MARINES" "ARMY" "ARMY_CORPS_OF_ENGINEERS" "AIR_AND_SPACE_FORCE" "COAST_GUARD" "OFFICE_OF_SECRETARY_OF_DEFENSE"
originDutyLocationId
required
string <uuid>
newDutyLocationId
required
string <uuid>
tac
string or null (HHG TAC) = 4 characters
sac
string (NullableString)
ntsTac
string (NullableString)
ntsSac
string (NullableString)
grade
string or null (grade)
Enum: "E_1" "E_2" "E_3" "E_4" "E_5" "E_6" "E_7" "E_8" "E_9" "E_9_SPECIAL_SENIOR_ENLISTED" "O_1_ACADEMY_GRADUATE" "O_2" "O_3" "O_4" "O_5" "O_6" "O_7" "O_8" "O_9" "O_10" "W_1" "W_2" "W_3" "W_4" "W_5" "AVIATION_CADET" "CIVILIAN_EMPLOYEE" "ACADEMY_CADET" "MIDSHIPMAN"
hasDependents
boolean or null (Are dependents included in your orders?)
dependentsAuthorized
boolean or null
civilianTdyUbAllowance
integer or null

The weight in pounds set by the customer or office user that a civilian TDY move is entitled to for Unaccompanied Baggage shipment types.

Responses

Request samples

Content type
application/json
{
  • "issueDate": "2018-04-26",
  • "reportByDate": "2018-04-26",
  • "ordersType": "PERMANENT_CHANGE_OF_STATION",
  • "ordersTypeDetail": "HHG_PERMITTED",
  • "ordersNumber": "030-00362",
  • "departmentIndicator": "NAVY_AND_MARINES",
  • "originDutyLocationId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "newDutyLocationId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "tac": "F8J1",
  • "sac": "string",
  • "ntsTac": "string",
  • "ntsSac": "string",
  • "grade": "E_1",
  • "hasDependents": true,
  • "dependentsAuthorized": true,
  • "civilianTdyUbAllowance": 3
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "customerID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "customer": {
    },
  • "moveCode": "H2XFJF",
  • "first_name": "John",
  • "last_name": "Doe",
  • "grade": "E_1",
  • "agency": "ARMY",
  • "entitlement": {
    },
  • "destinationDutyLocation": {
    },
  • "destinationDutyLocationGBLOC": "AGFM",
  • "originDutyLocation": {
    },
  • "originDutyLocationGBLOC": "AGFM",
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploaded_order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploadedAmendedOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "amendedOrdersAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "order_number": "030-00362",
  • "order_type": "PERMANENT_CHANGE_OF_STATION",
  • "order_type_detail": "HHG_PERMITTED",
  • "date_issued": "2020-01-01",
  • "report_by_date": "2020-01-01",
  • "department_indicator": "NAVY_AND_MARINES",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "ntsTac": "F8J1",
  • "ntsSac": "N002214CSW32Y9",
  • "has_dependents": false,
  • "spouse_has_pro_gear": false,
  • "supplyAndServicesCostEstimate": "string",
  • "packingAndShippingInstructions": "string",
  • "methodOfPayment": "string",
  • "naics": "string",
  • "orders_type": "PERMANENT_CHANGE_OF_STATION",
  • "eTag": "string"
}

Creates an orders model for a logged-in user

Creates an instance of orders tied to a service member, which allow for creation of a move and an entitlement. Orders are required before the creation of a move

Request Body schema: application/json
serviceMemberId
required
string <uuid>
issueDate
required
string <date> (Orders date)

The date and time that these orders were cut.

reportByDate
required
string <date> (Report-by date)

Report By Date

ordersType
required
string (Orders type)
Enum: "PERMANENT_CHANGE_OF_STATION" "LOCAL_MOVE" "RETIREMENT" "SEPARATION" "WOUNDED_WARRIOR" "BLUEBARK" "SAFETY" "TEMPORARY_DUTY" "EARLY_RETURN_OF_DEPENDENTS" "STUDENT_TRAVEL"
ordersTypeDetail
string or null (Orders type detail)
Enum: "HHG_PERMITTED" "PCS_TDY" "HHG_RESTRICTED_PROHIBITED" "HHG_RESTRICTED_AREA" "INSTRUCTION_20_WEEKS" "HHG_PROHIBITED_20_WEEKS" "DELAYED_APPROVAL"
hasDependents
required
boolean (Are dependents included in your orders?)
spouseHasProGear
required
boolean (Do you have a spouse who will need to move items related to their occupation (also known as spouse pro-gear)?)
newDutyLocationId
required
string <uuid>
counselingOfficeId
string or null <uuid>
ordersNumber
string or null (Orders Number)
tac
string or null (TAC)
sac
string or null (SAC)
departmentIndicator
string or null (Dept. indicator)
Enum: "NAVY_AND_MARINES" "ARMY" "ARMY_CORPS_OF_ENGINEERS" "AIR_AND_SPACE_FORCE" "COAST_GUARD" "OFFICE_OF_SECRETARY_OF_DEFENSE"
grade
string or null (grade)
Enum: "E_1" "E_2" "E_3" "E_4" "E_5" "E_6" "E_7" "E_8" "E_9" "E_9_SPECIAL_SENIOR_ENLISTED" "O_1_ACADEMY_GRADUATE" "O_2" "O_3" "O_4" "O_5" "O_6" "O_7" "O_8" "O_9" "O_10" "W_1" "W_2" "W_3" "W_4" "W_5" "AVIATION_CADET" "CIVILIAN_EMPLOYEE" "ACADEMY_CADET" "MIDSHIPMAN"
originDutyLocationId
string <uuid>
accompaniedTour
boolean or null

Indicates if the move entitlement allows dependents to travel to the new Permanent Duty Station (PDS). This is only present on OCONUS moves.

dependentsUnderTwelve
integer or null

Indicates the number of dependents under the age of twelve for a move. This is only present on OCONUS moves.

dependentsTwelveAndOver
integer or null

Indicates the number of dependents of the age twelve or older for a move. This is only present on OCONUS moves.

civilianTdyUbAllowance
integer or null

The weight in pounds set by the customer or office user that a civilian TDY move is entitled to for Unaccompanied Baggage shipment types.

Responses

Request samples

Content type
application/json
{
  • "serviceMemberId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "issueDate": "2019-08-24",
  • "reportByDate": "2019-08-24",
  • "ordersType": "PERMANENT_CHANGE_OF_STATION",
  • "ordersTypeDetail": "HHG_PERMITTED",
  • "hasDependents": true,
  • "spouseHasProGear": true,
  • "newDutyLocationId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "counselingOfficeId": "cf1addea-a4f9-4173-8506-2bb82a064cb7",
  • "ordersNumber": "030-00362",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "departmentIndicator": "NAVY_AND_MARINES",
  • "grade": "E_1",
  • "originDutyLocationId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "accompaniedTour": true,
  • "dependentsUnderTwelve": 5,
  • "dependentsTwelveAndOver": 3,
  • "civilianTdyUbAllowance": 3
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "customerID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "customer": {
    },
  • "moveCode": "H2XFJF",
  • "first_name": "John",
  • "last_name": "Doe",
  • "grade": "E_1",
  • "agency": "ARMY",
  • "entitlement": {
    },
  • "destinationDutyLocation": {
    },
  • "destinationDutyLocationGBLOC": "AGFM",
  • "originDutyLocation": {
    },
  • "originDutyLocationGBLOC": "AGFM",
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploaded_order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploadedAmendedOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "amendedOrdersAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "order_number": "030-00362",
  • "order_type": "PERMANENT_CHANGE_OF_STATION",
  • "order_type_detail": "HHG_PERMITTED",
  • "date_issued": "2020-01-01",
  • "report_by_date": "2020-01-01",
  • "department_indicator": "NAVY_AND_MARINES",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "ntsTac": "F8J1",
  • "ntsSac": "N002214CSW32Y9",
  • "has_dependents": false,
  • "spouse_has_pro_gear": false,
  • "supplyAndServicesCostEstimate": "string",
  • "packingAndShippingInstructions": "string",
  • "methodOfPayment": "string",
  • "naics": "string",
  • "orders_type": "PERMANENT_CHANGE_OF_STATION",
  • "eTag": "string"
}

Updates an order

All fields sent in this request will be set on the order referenced

path Parameters
orderID
required
string <uuid>

ID of order to use

header Parameters
If-Match
required
string
Request Body schema: application/json
issueDate
required
string <date> (Orders date)

The date and time that these orders were cut.

reportByDate
required
string <date> (Report-by date)

Report By Date

ordersType
required
string (Orders type)
Enum: "PERMANENT_CHANGE_OF_STATION" "LOCAL_MOVE" "RETIREMENT" "SEPARATION" "WOUNDED_WARRIOR" "BLUEBARK" "SAFETY" "TEMPORARY_DUTY" "EARLY_RETURN_OF_DEPENDENTS" "STUDENT_TRAVEL"
ordersTypeDetail
string or null (Orders type detail)
Enum: "HHG_PERMITTED" "PCS_TDY" "HHG_RESTRICTED_PROHIBITED" "HHG_RESTRICTED_AREA" "INSTRUCTION_20_WEEKS" "HHG_PROHIBITED_20_WEEKS" "DELAYED_APPROVAL"
originDutyLocationId
required
string <uuid>
newDutyLocationId
required
string <uuid>
ordersNumber
string or null (Orders Number)
tac
string or null (HHG TAC) = 4 characters
sac
string (NullableString)
ntsTac
string (NullableString)
ntsSac
string (NullableString)
departmentIndicator
string or null (Dept. indicator)
Enum: "NAVY_AND_MARINES" "ARMY" "ARMY_CORPS_OF_ENGINEERS" "AIR_AND_SPACE_FORCE" "COAST_GUARD" "OFFICE_OF_SECRETARY_OF_DEFENSE"
ordersAcknowledgement
boolean or null

Confirmation that the new amended orders were reviewed after previously approving the original orders

grade
string or null (grade)
Enum: "E_1" "E_2" "E_3" "E_4" "E_5" "E_6" "E_7" "E_8" "E_9" "E_9_SPECIAL_SENIOR_ENLISTED" "O_1_ACADEMY_GRADUATE" "O_2" "O_3" "O_4" "O_5" "O_6" "O_7" "O_8" "O_9" "O_10" "W_1" "W_2" "W_3" "W_4" "W_5" "AVIATION_CADET" "CIVILIAN_EMPLOYEE" "ACADEMY_CADET" "MIDSHIPMAN"
dependentsAuthorized
boolean or null
civilianTdyUbAllowance
integer or null

The weight in pounds set by the customer or office user that a civilian TDY move is entitled to for Unaccompanied Baggage shipment types.

Responses

Request samples

Content type
application/json
{
  • "issueDate": "2018-04-26",
  • "reportByDate": "2018-04-26",
  • "ordersType": "PERMANENT_CHANGE_OF_STATION",
  • "ordersTypeDetail": "HHG_PERMITTED",
  • "originDutyLocationId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "newDutyLocationId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "ordersNumber": "030-00362",
  • "tac": "F8J1",
  • "sac": "string",
  • "ntsTac": "string",
  • "ntsSac": "string",
  • "departmentIndicator": "NAVY_AND_MARINES",
  • "ordersAcknowledgement": true,
  • "grade": "E_1",
  • "dependentsAuthorized": true,
  • "civilianTdyUbAllowance": 3
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "customerID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "customer": {
    },
  • "moveCode": "H2XFJF",
  • "first_name": "John",
  • "last_name": "Doe",
  • "grade": "E_1",
  • "agency": "ARMY",
  • "entitlement": {
    },
  • "destinationDutyLocation": {
    },
  • "destinationDutyLocationGBLOC": "AGFM",
  • "originDutyLocation": {
    },
  • "originDutyLocationGBLOC": "AGFM",
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploaded_order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploadedAmendedOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "amendedOrdersAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "order_number": "030-00362",
  • "order_type": "PERMANENT_CHANGE_OF_STATION",
  • "order_type_detail": "HHG_PERMITTED",
  • "date_issued": "2020-01-01",
  • "report_by_date": "2020-01-01",
  • "department_indicator": "NAVY_AND_MARINES",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "ntsTac": "F8J1",
  • "ntsSac": "N002214CSW32Y9",
  • "has_dependents": false,
  • "spouse_has_pro_gear": false,
  • "supplyAndServicesCostEstimate": "string",
  • "packingAndShippingInstructions": "string",
  • "methodOfPayment": "string",
  • "naics": "string",
  • "orders_type": "PERMANENT_CHANGE_OF_STATION",
  • "eTag": "string"
}

Gets an order by ID

Gets an order

path Parameters
orderID
required
string <uuid>

ID of order to use

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "customerID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "customer": {
    },
  • "moveCode": "H2XFJF",
  • "first_name": "John",
  • "last_name": "Doe",
  • "grade": "E_1",
  • "agency": "ARMY",
  • "entitlement": {
    },
  • "destinationDutyLocation": {
    },
  • "destinationDutyLocationGBLOC": "AGFM",
  • "originDutyLocation": {
    },
  • "originDutyLocationGBLOC": "AGFM",
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploaded_order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploadedAmendedOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "amendedOrdersAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "order_number": "030-00362",
  • "order_type": "PERMANENT_CHANGE_OF_STATION",
  • "order_type_detail": "HHG_PERMITTED",
  • "date_issued": "2020-01-01",
  • "report_by_date": "2020-01-01",
  • "department_indicator": "NAVY_AND_MARINES",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "ntsTac": "F8J1",
  • "ntsSac": "N002214CSW32Y9",
  • "has_dependents": false,
  • "spouse_has_pro_gear": false,
  • "supplyAndServicesCostEstimate": "string",
  • "packingAndShippingInstructions": "string",
  • "methodOfPayment": "string",
  • "naics": "string",
  • "orders_type": "PERMANENT_CHANGE_OF_STATION",
  • "eTag": "string"
}

Updates an allowance (Orders with Entitlements)

All fields sent in this request will be set on the order referenced

path Parameters
orderID
required
string <uuid>

ID of order to use

header Parameters
If-Match
required
string
Request Body schema: application/json
grade
string or null (grade)
Enum: "E_1" "E_2" "E_3" "E_4" "E_5" "E_6" "E_7" "E_8" "E_9" "E_9_SPECIAL_SENIOR_ENLISTED" "O_1_ACADEMY_GRADUATE" "O_2" "O_3" "O_4" "O_5" "O_6" "O_7" "O_8" "O_9" "O_10" "W_1" "W_2" "W_3" "W_4" "W_5" "AVIATION_CADET" "CIVILIAN_EMPLOYEE" "ACADEMY_CADET" "MIDSHIPMAN"
agency
string or null (Branch of service)
Enum: "ARMY" "NAVY" "MARINES" "AIR_FORCE" "COAST_GUARD" "SPACE_FORCE" "OTHER"

Military branch of service

proGearWeight
integer or null [ 0 .. 2000 ]

unit is in lbs

proGearWeightSpouse
integer or null [ 0 .. 500 ]

unit is in lbs

requiredMedicalEquipmentWeight
integer >= 0

unit is in lbs

organizationalClothingAndIndividualEquipment
boolean or null

only for Army

storageInTransit
integer >= 0

the number of storage in transit days that the customer is entitled to for a given shipment on their move

gunSafe
boolean or null

True if user is entitled to move a gun safe (up to 500 lbs) as part of their move without it being charged against their weight allowance.

accompaniedTour
boolean or null

Indicates if the move entitlement allows dependents to travel to the new Permanent Duty Station (PDS). This is only present on OCONUS moves.

dependentsUnderTwelve
integer or null

Indicates the number of dependents under the age of twelve for a move. This is only present on OCONUS moves.

dependentsTwelveAndOver
integer or null

Indicates the number of dependents of the age twelve or older for a move. This is only present on OCONUS moves.

ubAllowance
integer or null
weightRestriction
integer or null

Indicates the weight restriction for the move to a particular location.

ubWeightRestriction
integer or null

Indicates the UB weight restriction for the move to a particular location.

Responses

Request samples

Content type
application/json
{
  • "grade": "E_1",
  • "agency": "ARMY",
  • "proGearWeight": 2000,
  • "proGearWeightSpouse": 500,
  • "requiredMedicalEquipmentWeight": 2000,
  • "organizationalClothingAndIndividualEquipment": true,
  • "storageInTransit": 0,
  • "gunSafe": true,
  • "accompaniedTour": true,
  • "dependentsUnderTwelve": 5,
  • "dependentsTwelveAndOver": 3,
  • "ubAllowance": 500,
  • "weightRestriction": 1500,
  • "ubWeightRestriction": 1500
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "customerID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "customer": {
    },
  • "moveCode": "H2XFJF",
  • "first_name": "John",
  • "last_name": "Doe",
  • "grade": "E_1",
  • "agency": "ARMY",
  • "entitlement": {
    },
  • "destinationDutyLocation": {
    },
  • "destinationDutyLocationGBLOC": "AGFM",
  • "originDutyLocation": {
    },
  • "originDutyLocationGBLOC": "AGFM",
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploaded_order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploadedAmendedOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "amendedOrdersAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "order_number": "030-00362",
  • "order_type": "PERMANENT_CHANGE_OF_STATION",
  • "order_type_detail": "HHG_PERMITTED",
  • "date_issued": "2020-01-01",
  • "report_by_date": "2020-01-01",
  • "department_indicator": "NAVY_AND_MARINES",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "ntsTac": "F8J1",
  • "ntsSac": "N002214CSW32Y9",
  • "has_dependents": false,
  • "spouse_has_pro_gear": false,
  • "supplyAndServicesCostEstimate": "string",
  • "packingAndShippingInstructions": "string",
  • "methodOfPayment": "string",
  • "naics": "string",
  • "orders_type": "PERMANENT_CHANGE_OF_STATION",
  • "eTag": "string"
}

Saves the date and time a TOO acknowledged the excess weight risk by dismissing the alert

Saves the date and time a TOO acknowledged the excess weight risk by dismissing the alert

path Parameters
orderID
required
string <uuid>

ID of order to use

header Parameters
If-Match
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Saves the date and time a TOO acknowledged the excess unaccompanied baggage weight risk by dismissing the alert

Saves the date and time a TOO acknowledged the excess unaccompanied baggage weight risk by dismissing the alert

path Parameters
orderID
required
string <uuid>

ID of order to use

header Parameters
If-Match
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Updates the max billable weight

Updates the DBAuthorizedWeight attribute for the Order Entitlements=

path Parameters
orderID
required
string <uuid>

ID of order to use

header Parameters
If-Match
required
string
Request Body schema: application/json
authorizedWeight
integer or null >= 1

unit is in lbs

Responses

Request samples

Content type
application/json
{
  • "authorizedWeight": 2000
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "customerID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "customer": {
    },
  • "moveCode": "H2XFJF",
  • "first_name": "John",
  • "last_name": "Doe",
  • "grade": "E_1",
  • "agency": "ARMY",
  • "entitlement": {
    },
  • "destinationDutyLocation": {
    },
  • "destinationDutyLocationGBLOC": "AGFM",
  • "originDutyLocation": {
    },
  • "originDutyLocationGBLOC": "AGFM",
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploaded_order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploadedAmendedOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "amendedOrdersAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "order_number": "030-00362",
  • "order_type": "PERMANENT_CHANGE_OF_STATION",
  • "order_type_detail": "HHG_PERMITTED",
  • "date_issued": "2020-01-01",
  • "report_by_date": "2020-01-01",
  • "department_indicator": "NAVY_AND_MARINES",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "ntsTac": "F8J1",
  • "ntsSac": "N002214CSW32Y9",
  • "has_dependents": false,
  • "spouse_has_pro_gear": false,
  • "supplyAndServicesCostEstimate": "string",
  • "packingAndShippingInstructions": "string",
  • "methodOfPayment": "string",
  • "naics": "string",
  • "orders_type": "PERMANENT_CHANGE_OF_STATION",
  • "eTag": "string"
}

Updates the max billable weight with TIO remarks

Updates the DBAuthorizedWeight attribute for the Order Entitlements and move TIO remarks

path Parameters
orderID
required
string <uuid>

ID of order to use

header Parameters
If-Match
required
string

Optimistic locking is implemented via the If-Match header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a 412 Precondition Failed error.

Request Body schema: application/json
authorizedWeight
required
integer or null >= 1

unit is in lbs

tioRemarks
required
string or null non-empty

TIO remarks for updating the max billable weight

Responses

Request samples

Content type
application/json
{
  • "authorizedWeight": 2000,
  • "tioRemarks": "Increasing max billable weight"
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "customerID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "customer": {
    },
  • "moveCode": "H2XFJF",
  • "first_name": "John",
  • "last_name": "Doe",
  • "grade": "E_1",
  • "agency": "ARMY",
  • "entitlement": {
    },
  • "destinationDutyLocation": {
    },
  • "destinationDutyLocationGBLOC": "AGFM",
  • "originDutyLocation": {
    },
  • "originDutyLocationGBLOC": "AGFM",
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploaded_order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploadedAmendedOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "amendedOrdersAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "order_number": "030-00362",
  • "order_type": "PERMANENT_CHANGE_OF_STATION",
  • "order_type_detail": "HHG_PERMITTED",
  • "date_issued": "2020-01-01",
  • "report_by_date": "2020-01-01",
  • "department_indicator": "NAVY_AND_MARINES",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "ntsTac": "F8J1",
  • "ntsSac": "N002214CSW32Y9",
  • "has_dependents": false,
  • "spouse_has_pro_gear": false,
  • "supplyAndServicesCostEstimate": "string",
  • "packingAndShippingInstructions": "string",
  • "methodOfPayment": "string",
  • "naics": "string",
  • "orders_type": "PERMANENT_CHANGE_OF_STATION",
  • "eTag": "string"
}

Create an amended order for a given order

Create an amended order for a given order

path Parameters
orderID
required
string <uuid>

UUID of the order

Request Body schema: multipart/form-data
file
required
string <binary>

The file to upload.

Responses

Updates an allowance (Orders with Entitlements)

All fields sent in this request will be set on the order referenced

path Parameters
orderID
required
string <uuid>

ID of order to use

header Parameters
If-Match
required
string
Request Body schema: application/json
grade
string or null (grade)
Enum: "E_1" "E_2" "E_3" "E_4" "E_5" "E_6" "E_7" "E_8" "E_9" "E_9_SPECIAL_SENIOR_ENLISTED" "O_1_ACADEMY_GRADUATE" "O_2" "O_3" "O_4" "O_5" "O_6" "O_7" "O_8" "O_9" "O_10" "W_1" "W_2" "W_3" "W_4" "W_5" "AVIATION_CADET" "CIVILIAN_EMPLOYEE" "ACADEMY_CADET" "MIDSHIPMAN"
agency
string or null (Branch of service)
Enum: "ARMY" "NAVY" "MARINES" "AIR_FORCE" "COAST_GUARD" "SPACE_FORCE" "OTHER"

Military branch of service

proGearWeight
integer or null [ 0 .. 2000 ]

unit is in lbs

proGearWeightSpouse
integer or null [ 0 .. 500 ]

unit is in lbs

requiredMedicalEquipmentWeight
integer >= 0

unit is in lbs

organizationalClothingAndIndividualEquipment
boolean or null

only for Army

storageInTransit
integer >= 0

the number of storage in transit days that the customer is entitled to for a given shipment on their move

gunSafe
boolean or null

True if user is entitled to move a gun safe (up to 500 lbs) as part of their move without it being charged against their weight allowance.

accompaniedTour
boolean or null

Indicates if the move entitlement allows dependents to travel to the new Permanent Duty Station (PDS). This is only present on OCONUS moves.

dependentsUnderTwelve
integer or null

Indicates the number of dependents under the age of twelve for a move. This is only present on OCONUS moves.

dependentsTwelveAndOver
integer or null

Indicates the number of dependents of the age twelve or older for a move. This is only present on OCONUS moves.

ubAllowance
integer or null
weightRestriction
integer or null

Indicates the weight restriction for a move to a particular location.

ubWeightRestriction
integer or null

Indicates the UB weight restriction for the move to a particular location.

Responses

Request samples

Content type
application/json
{
  • "grade": "E_1",
  • "agency": "ARMY",
  • "proGearWeight": 2000,
  • "proGearWeightSpouse": 2000,
  • "requiredMedicalEquipmentWeight": 2000,
  • "organizationalClothingAndIndividualEquipment": true,
  • "storageInTransit": 0,
  • "gunSafe": true,
  • "accompaniedTour": true,
  • "dependentsUnderTwelve": 5,
  • "dependentsTwelveAndOver": 3,
  • "ubAllowance": 500,
  • "weightRestriction": 1500,
  • "ubWeightRestriction": 1500
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "customerID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "customer": {
    },
  • "moveCode": "H2XFJF",
  • "first_name": "John",
  • "last_name": "Doe",
  • "grade": "E_1",
  • "agency": "ARMY",
  • "entitlement": {
    },
  • "destinationDutyLocation": {
    },
  • "destinationDutyLocationGBLOC": "AGFM",
  • "originDutyLocation": {
    },
  • "originDutyLocationGBLOC": "AGFM",
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploaded_order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "uploadedAmendedOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "amendedOrdersAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "order_number": "030-00362",
  • "order_type": "PERMANENT_CHANGE_OF_STATION",
  • "order_type_detail": "HHG_PERMITTED",
  • "date_issued": "2020-01-01",
  • "report_by_date": "2020-01-01",
  • "department_indicator": "NAVY_AND_MARINES",
  • "tac": "F8J1",
  • "sac": "N002214CSW32Y9",
  • "ntsTac": "F8J1",
  • "ntsSac": "N002214CSW32Y9",
  • "has_dependents": false,
  • "spouse_has_pro_gear": false,
  • "supplyAndServicesCostEstimate": "string",
  • "packingAndShippingInstructions": "string",
  • "methodOfPayment": "string",
  • "naics": "string",
  • "orders_type": "PERMANENT_CHANGE_OF_STATION",
  • "eTag": "string"
}

Validation of a TAC value

Returns a boolean based on whether a tac value is valid or not

query Parameters
tac
required
string

The tac value to validate

Responses

moveTaskOrder

Gets a move by ID

Gets a move

path Parameters
moveTaskOrderID
required
string

ID of move to use

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "orderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "locator": "1K43AR",
  • "referenceId": "1001-3456",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "destinationAddress": {
    },
  • "pickupAddress": {
    },
  • "destinationDutyLocation": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "originDutyLocation": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "entitlements": {
    },
  • "requestedPickupDate": "2019-08-24",
  • "tioRemarks": "approved additional weight",
  • "eTag": "string"
}

Change the status of a move task order

Changes move task order status

path Parameters
moveTaskOrderID
required
string

ID of move to use

header Parameters
If-Match
required
string
Request Body schema: application/json
serviceCodeCS
boolean
serviceCodeMS
boolean

Responses

Request samples

Content type
application/json
{
  • "serviceCodeCS": true,
  • "serviceCodeMS": true
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Changes move (move task order) status to service counseling completed

Changes move (move task order) status to service counseling completed

path Parameters
moveTaskOrderID
required
string

ID of move to use

header Parameters
If-Match
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

updateMTOReviewedBillableWeightsAt

Changes move (move task order) billableWeightsReviewedAt field to a timestamp

path Parameters
moveTaskOrderID
required
string

ID of move to use

header Parameters
If-Match
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

updateMoveTIORemarks

Changes move (move task order) billableWeightsReviewedAt field to a timestamp

path Parameters
moveTaskOrderID
required
string

ID of move to use

header Parameters
If-Match
required
string
Request Body schema: application/json
id
string <uuid>
serviceCounselingCompletedAt
string or null <date-time>
availableToPrimeAt
string or null <date-time>
approvedAt
string or null <date-time>
billableWeightsReviewedAt
string or null <date-time>
contractorId
string or null <uuid>
object (Contractor)
locator
string
ordersId
string <uuid>
object (Order)
referenceId
string or null
status
string (MoveStatus)
Enum: "DRAFT" "NEEDS SERVICE COUNSELING" "SERVICE COUNSELING COMPLETED" "SUBMITTED" "APPROVALS REQUESTED" "APPROVED" "CANCELED"
excessUnaccompaniedBaggageWeightQualifiedAt
string or null <date-time>

Timestamp of when the sum of estimated or actual unaccompanied baggage shipment weights of the move reached 90% of the weight allowance

excessUnaccompaniedBaggageWeightAcknowledgedAt
string or null <date-time>

Timestamp of when the TOO acknowledged the excess unaccompanied baggage weight risk by either dismissing the alert or updating the max billable weight

excess_weight_qualified_at
string or null <date-time>

Timestamp of when the estimated shipment weights of the move reached 90% of the weight allowance

excess_weight_acknowledged_at
string or null <date-time>

Timestamp of when the TOO acknowledged the excess weight risk by either dismissing the alert or updating the max billable weight

tioRemarks
string or null
object (TransportationOffice)
closeoutOfficeId
string or null <uuid>

The transportation office that will handle reviewing PPM Closeout documentation for Army and Air Force service members

object (TransportationOffice)
counselingOfficeId
string or null <uuid>

The transportation office that will handle services counseling for this move

approvalsRequestedAt
string or null <date-time>

The time at which a move is sent back to the TOO becuase the prime added a new service item for approval

createdAt
string <date-time>
submittedAt
string or null <date-time>
updatedAt
string <date-time>
eTag
string
shipmentGBLOC
string (GBLOC)
Enum: "AGFM" "APAT" "BGAC" "BGNC" "BKAS" "CFMQ" "CLPK" "CNNQ" "DMAT" "GSAT" "HAFC" "HBAT" "JEAT" "JENQ" "KKFA" "LHNQ" "LKNQ" "MAPK" "MAPS" "MBFL" "MLNQ" "XXXX"
lockedByOfficeUserID
string or null <uuid>
object (LockedOfficeUser)
lockExpiresAt
string or null <date-time>
object (Document)
object (AssignedOfficeUser)
object (AssignedOfficeUser)
object (AssignedOfficeUser)
object (AssignedOfficeUser)

Responses

Request samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "serviceCounselingCompletedAt": "2019-08-24T14:15:22Z",
  • "availableToPrimeAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "billableWeightsReviewedAt": "2019-08-24T14:15:22Z",
  • "contractorId": "8e641c22-41f4-4818-ae43-d2cb9b53e3d7",
  • "contractor": {
    },
  • "locator": "1K43AR",
  • "ordersId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "orders": {
    },
  • "referenceId": "1001-3456",
  • "status": "DRAFT",
  • "excessUnaccompaniedBaggageWeightQualifiedAt": "2019-08-24T14:15:22Z",
  • "excessUnaccompaniedBaggageWeightAcknowledgedAt": "2019-08-24T14:15:22Z",
  • "excess_weight_qualified_at": "2019-08-24T14:15:22Z",
  • "excess_weight_acknowledged_at": "2019-08-24T14:15:22Z",
  • "tioRemarks": "approved additional weight",
  • "financialReviewFlag": false,
  • "financialReviewRemarks": "Delivery Address is too far from duty location",
  • "closeoutOffice": {
    },
  • "closeoutOfficeId": "4cbd0d90-9d3e-401a-a020-95aa165733e2",
  • "counselingOffice": {
    },
  • "counselingOfficeId": "31373a98-b5f6-486a-ad6a-c1d9356b4e81",
  • "approvalsRequestedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "shipmentGBLOC": "AGFM",
  • "lockedByOfficeUserID": "97d95fcf-e694-4c9a-85c3-276951b93fe7",
  • "lockedByOfficeUser": {
    },
  • "lockExpiresAt": "2019-08-24T14:15:22Z",
  • "additionalDocuments": {
    },
  • "SCAssignedUser": {
    },
  • "TOOAssignedUser": {
    },
  • "TIOAssignedUser": {
    },
  • "TOODestinationAssignedUser": {
    }
}

Gets entitlements for a move by ID

Gets entitlements

path Parameters
moveTaskOrderID
required
string

ID of move to use

Responses

Response samples

Content type
application/json
{
  • "id": "571008b1-b0de-454d-b843-d71be9f02c04",
  • "authorizedWeight": 2000,
  • "dependentsAuthorized": true,
  • "gunSafe": false,
  • "weightRestriction": 1500,
  • "ubWeightRestriction": 1500,
  • "nonTemporaryStorage": false,
  • "privatelyOwnedVehicle": false,
  • "proGearWeight": 2000,
  • "proGearWeightSpouse": 500,
  • "storageInTransit": 90,
  • "totalWeight": 500,
  • "totalDependents": 2,
  • "requiredMedicalEquipmentWeight": 500,
  • "organizationalClothingAndIndividualEquipment": true,
  • "accompaniedTour": true,
  • "unaccompaniedBaggageAllowance": 3,
  • "dependentsUnderTwelve": 5,
  • "dependentsTwelveAndOver": 3,
  • "eTag": "string"
}

customer

Creates a customer with Okta option

Creates a customer with option to also create an Okta profile account based on the office user's input when completing the UI form and submitting.

Request Body schema: application/json
affiliation
string or null (Branch of service)
Enum: "ARMY" "NAVY" "MARINES" "AIR_FORCE" "COAST_GUARD" "SPACE_FORCE" "OTHER"

Military branch of service

edipi
string <= 10 characters
emplid
string or null <= 7 characters
firstName
string
middleName
string or null
lastName
string
suffix
string or null
telephone
string or null <telephone> ^[2-9]\d{2}-\d{3}-\d{4}$
secondaryTelephone
string or null <telephone> ^[2-9]\d{2}-\d{3}-\d{4}$
personalEmail
string <x-email> ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...
phoneIsPreferred
boolean
emailIsPreferred
boolean
object

A postal address

object (BackupContact)
object

A postal address

createOktaAccount
boolean
cacUser
boolean

Responses

Request samples

Content type
application/json
{
  • "affiliation": "ARMY",
  • "edipi": "1234567890",
  • "emplid": "9485155",
  • "firstName": "John",
  • "middleName": "David",
  • "lastName": "Doe",
  • "suffix": "Jr.",
  • "telephone": "string",
  • "secondaryTelephone": "string",
  • "personalEmail": "personalEmail@email.com",
  • "phoneIsPreferred": true,
  • "emailIsPreferred": true,
  • "residentialAddress": {
    },
  • "backupContact": {
    },
  • "backupMailingAddress": {
    },
  • "createOktaAccount": true,
  • "cacUser": true
}

Response samples

Content type
application/json
{
  • "affiliation": "string",
  • "firstName": "John",
  • "lastName": "Doe",
  • "telephone": "string",
  • "personalEmail": "string",
  • "suffix": "Jr.",
  • "middleName": "David",
  • "residentialAddress": {
    },
  • "backupContact": {
    },
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "edipi": "string",
  • "userID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "oktaID": "string",
  • "oktaEmail": "string",
  • "phoneIsPreferred": true,
  • "emailIsPreferred": true,
  • "secondaryTelephone": "string",
  • "backupAddress": {
    },
  • "cacValidated": true
}

Returns a given customer

Returns a given customer

path Parameters
customerID
required
string <uuid>

ID of customer to use

Responses

Response samples

Content type
application/json
{
  • "agency": "string",
  • "first_name": "John",
  • "last_name": "Doe",
  • "phone": "string",
  • "email": "string",
  • "suffix": "Jr.",
  • "middle_name": "David",
  • "current_address": {
    },
  • "backup_contact": {
    },
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "edipi": "string",
  • "userID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "eTag": "string",
  • "phoneIsPreferred": true,
  • "emailIsPreferred": true,
  • "secondaryTelephone": "string",
  • "backupAddress": {
    },
  • "cacValidated": true,
  • "emplid": "string"
}

Updates customer info

Updates customer info by ID

path Parameters
customerID
required
string <uuid>

ID of customer to use

header Parameters
If-Match
required
string
Request Body schema: application/json
first_name
string
last_name
string
phone
string or null <telephone> ^[2-9]\d{2}-\d{3}-\d{4}$
email
string or null <x-email> ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...
suffix
string or null
middle_name
string or null
object

A postal address

object (BackupContact)
phoneIsPreferred
boolean
emailIsPreferred
boolean
secondaryTelephone
string or null <telephone> ^[2-9]\d{2}-\d{3}-\d{4}$|^$
object

A postal address

cac_validated
boolean

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Doe",
  • "phone": "string",
  • "email": "string",
  • "suffix": "Jr.",
  • "middle_name": "David",
  • "current_address": {
    },
  • "backup_contact": {
    },
  • "phoneIsPreferred": true,
  • "emailIsPreferred": true,
  • "secondaryTelephone": "string",
  • "backupAddress": {
    },
  • "cac_validated": true
}

Response samples

Content type
application/json
{
  • "agency": "string",
  • "first_name": "John",
  • "last_name": "Doe",
  • "phone": "string",
  • "email": "string",
  • "suffix": "Jr.",
  • "middle_name": "David",
  • "current_address": {
    },
  • "backup_contact": {
    },
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "edipi": "string",
  • "userID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "eTag": "string",
  • "phoneIsPreferred": true,
  • "emailIsPreferred": true,
  • "secondaryTelephone": "string",
  • "backupAddress": {
    },
  • "cacValidated": true,
  • "emplid": "string"
}

Search customers by DOD ID or customer name

Search customers by DOD ID or customer name. Used by services counselors to locate profiles to update, find attached moves, and to create new moves.

Request Body schema: application/json

field that results should be sorted by

page
integer

requested page of results

perPage
integer
edipi
string or null = 10 characters

DOD ID

emplid
string or null = 7 characters

EMPLID

branch
string non-empty

Branch

customerName
string or null non-empty

Customer Name

sort
string or null
Enum: "customerName" "edipi" "emplid" "branch" "personalEmail" "telephone"
order
string or null
Enum: "asc" "desc"

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "edipi": "stringstri",
  • "emplid": "strings",
  • "branch": "string",
  • "customerName": "string",
  • "sort": "customerName",
  • "order": "asc"
}

Response samples

Content type
application/json
{
  • "page": 0,
  • "perPage": 0,
  • "totalCount": 0,
  • "searchCustomers": [
    ]
}

mtoServiceItem

Gets all line items for a move

Gets all line items for a move

path Parameters
moveTaskOrderID
required
string <uuid>

ID of move for mto service item to use

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Converts a SIT to customer expense

Converts a SIT to customer expense

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string
Request Body schema: application/json
convertToCustomerExpense
required
boolean
customerExpenseReason
required
string

Reason the service item was rejected

Responses

Request samples

Content type
application/json
{
  • "convertToCustomerExpense": true,
  • "customerExpenseReason": "Insufficent details provided"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Gets a line item by ID for a move by ID

Gets a line item by ID for a move by ID

path Parameters
moveTaskOrderID
required
string

ID of move to use

mtoServiceItemID
required
string

ID of line item to use

Responses

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "mtoShipmentID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "reServiceID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "reServiceCode": "string",
  • "reServiceName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "convertToCustomerExpense": false,
  • "customerExpenseReason": "string",
  • "deletedAt": "2019-08-24",
  • "rejectionReason": "string",
  • "pickupPostalCode": "string",
  • "sitPostalCode": "string",
  • "sitEntryDate": "2019-08-24T14:15:22Z",
  • "sitDepartureDate": "2019-08-24T14:15:22Z",
  • "sitCustomerContacted": "2019-08-24",
  • "sitRequestedDelivery": "2019-08-24",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "status": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "rejectedAt": "2019-08-24T14:15:22Z"
}

Change the status of a line item for a move by ID

Changes the status of a line item for a move by ID

path Parameters
moveTaskOrderID
required
string

ID of move to use

mtoServiceItemID
required
string

ID of line item to use

header Parameters
If-Match
required
string
Request Body schema: application/json
status
string
Enum: "SUBMITTED" "APPROVED" "REJECTED"

Describes all statuses for a MTOServiceItem

rejectionReason
string or null

Reason the service item was rejected

Responses

Request samples

Content type
application/json
{
  • "status": "SUBMITTED",
  • "rejectionReason": "Insufficent details provided"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "mtoShipmentID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "reServiceID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "reServiceCode": "string",
  • "reServiceName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "convertToCustomerExpense": false,
  • "customerExpenseReason": "string",
  • "customerContacts": [
    ],
  • "deletedAt": "2019-08-24",
  • "description": "string",
  • "dimensions": [
    ],
  • "reason": "string",
  • "rejectionReason": "string",
  • "pickupPostalCode": "string",
  • "SITPostalCode": "string",
  • "sitEntryDate": "2019-08-24T14:15:22Z",
  • "sitDepartureDate": "2019-08-24T14:15:22Z",
  • "sitCustomerContacted": "2019-08-24",
  • "sitRequestedDelivery": "2019-08-24",
  • "sitDestinationOriginalAddress": {
    },
  • "sitOriginHHGOriginalAddress": {
    },
  • "sitOriginHHGActualAddress": {
    },
  • "sitDestinationFinalAddress": {
    },
  • "sitDeliveryMiles": 0,
  • "feeType": "COUNSELING",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "quantity": 0,
  • "rate": 0,
  • "status": "SUBMITTED",
  • "submittedAt": "2019-08-24",
  • "total": 0,
  • "estimatedWeight": 2500,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "rejectedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "updateReason": "string",
  • "standaloneCrate": true,
  • "externalCrate": true,
  • "serviceRequestDocuments": [
    ],
  • "estimatedPrice": 0,
  • "lockedPriceCents": 0,
  • "market": "CONUS",
  • "sort": "string"
}

Updates a service item's SIT entry date by ID

Locates the service item in the database and updates the SIT entry date for the selected service item and returns the service item

path Parameters
mtoServiceItemID
required
string

ID of the service item

Request Body schema: application/json
id
string <uuid>
sitEntryDate
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "sitEntryDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "mtoShipmentID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "reServiceID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "reServiceCode": "string",
  • "reServiceName": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "convertToCustomerExpense": false,
  • "customerExpenseReason": "string",
  • "deletedAt": "2019-08-24",
  • "rejectionReason": "string",
  • "pickupPostalCode": "string",
  • "sitPostalCode": "string",
  • "sitEntryDate": "2019-08-24T14:15:22Z",
  • "sitDepartureDate": "2019-08-24T14:15:22Z",
  • "sitCustomerContacted": "2019-08-24",
  • "sitRequestedDelivery": "2019-08-24",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "status": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "rejectedAt": "2019-08-24T14:15:22Z"
}

mtoShipment

createMTOShipment

Creates a MTO shipment for the specified Move Task Order. Required fields include:

  • Shipment Type
  • Customer requested pick-up date
  • Pick-up Address
  • Delivery Address
  • Releasing / Receiving agents Optional fields include:
  • Delivery Address Type
  • Customer Remarks
  • Releasing / Receiving agents
  • An array of optional accessorial service item codes
Request Body schema: application/json
moveTaskOrderID
required
string <uuid>

The ID of the move this new shipment is for.

requestedPickupDate
string or null <date>

The customer's preferred pickup date. Other dates, such as required delivery date and (outside MilMove) the pack date, are derived from this date.

requestedDeliveryDate
string or null <date>

The customer's preferred delivery date.

customerRemarks
string or null

The customer can use the customer remarks field to inform the services counselor and the movers about any special circumstances for this shipment. Typical examples:

  • bulky or fragile items,
  • weapons,
  • access info for their address. Customer enters this information during onboarding. Optional field.
counselorRemarks
string or null

The counselor can use the counselor remarks field to inform the movers about any special circumstances for this shipment. Typical examples:

  • bulky or fragile items,
  • weapons,
  • access info for their address. Counselors enters this information when creating or editing an MTO Shipment. Optional field.
Array of objects (MTOAgents)
Array of objects (MTOServiceItems)

A list of service items connected to this shipment.

object

The address where the movers should pick up this shipment.

object

Where the movers should deliver this shipment.

hasSecondaryPickupAddress
boolean or null
object

The address where the movers should pick up this shipment.

hasSecondaryDeliveryAddress
boolean or null
object

Where the movers should deliver this shipment.

hasTertiaryPickupAddress
boolean or null
object

The address where the movers should pick up this shipment.

hasTertiaryDeliveryAddress
boolean or null
object

Where the movers should deliver this shipment.

destinationType
string or null (Destination Type)
Enum: "HOME_OF_RECORD" "HOME_OF_SELECTION" "PLACE_ENTERED_ACTIVE_DUTY" "OTHER_THAN_AUTHORIZED"
shipmentType
required
string (Shipment Type)
Enum: "HHG" "HHG_INTO_NTS" "HHG_OUTOF_NTS" "PPM" "BOAT_HAUL_AWAY" "BOAT_TOW_AWAY" "MOBILE_HOME" "UNACCOMPANIED_BAGGAGE"
tacType
string or null
Enum: "HHG" "NTS"

The Line of accounting (TAC/SAC) type that will be used for the shipment

sacType
string or null
Enum: "HHG" "NTS"

The Line of accounting (TAC/SAC) type that will be used for the shipment

usesExternalVendor
boolean or null
serviceOrderNumber
string or null
ntsRecordedWeight
integer or null

The previously recorded weight for the NTS Shipment. Used for NTS Release to know what the previous primeActualWeight or billable weight was.

object (StorageFacility)

The Storage Facility information for the shipment

object (CreateMobileHomeShipment)

A mobile home shipment that the prime moves for a service member.

object (CreatePPMShipment)

A personally procured move is a type of shipment that a service members moves themselves.

object (CreateBoatShipment)

Boat shipment information for the move.

Responses

Request samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "requestedPickupDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "agents": [
    ],
  • "mtoServiceItems": [
    ],
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "secondaryPickupAddress": {
    },
  • "hasSecondaryDeliveryAddress": true,
  • "secondaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "hasTertiaryDeliveryAddress": true,
  • "tertiaryDeliveryAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "shipmentType": "HHG",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "ntsRecordedWeight": 2000,
  • "storageFacility": {
    },
  • "mobileHomeShipment": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    }
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Gets all shipments for a move task order

Gets all shipments for a move task order

path Parameters
moveTaskOrderID
required
string <uuid>

ID of move task order for mto shipment to use

Responses

Response samples

Content type
application/json
[
  • {
    }
]

fetches a shipment by ID

fetches a shipment by ID

path Parameters
shipmentID
required
string <uuid>

ID of the shipment to be fetched

Responses

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

updateMTOShipment

Updates a specified MTO shipment. Required fields include:

  • MTO Shipment ID required in path
  • If-Match required in headers
  • No fields required in body Optional fields include:
  • New shipment status type
  • Shipment Type
  • Customer requested pick-up date
  • Pick-up Address
  • Delivery Address
  • Secondary Pick-up Address
  • SecondaryDelivery Address
  • Delivery Address Type
  • Customer Remarks
  • Counselor Remarks
  • Releasing / Receiving agents
  • Actual Pro Gear Weight
  • Actual Spouse Pro Gear Weight
  • Location of the POE/POD
path Parameters
moveTaskOrderID
required
string <uuid>

ID of move task order for mto shipment to use

shipmentID
required
string <uuid>

UUID of the MTO Shipment to update

header Parameters
If-Match
required
string

Optimistic locking is implemented via the If-Match header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a 412 Precondition Failed error.

Request Body schema: application/json
shipmentType
string (Shipment Type)
Enum: "HHG" "HHG_INTO_NTS" "HHG_OUTOF_NTS" "PPM" "BOAT_HAUL_AWAY" "BOAT_TOW_AWAY" "MOBILE_HOME" "UNACCOMPANIED_BAGGAGE"
requestedPickupDate
string or null <date>
requestedDeliveryDate
string or null <date>
customerRemarks
string or null
counselorRemarks
string or null
billableWeightCap
integer or null

estimated weight of the shuttle service item provided by the prime

billableWeightJustification
string or null
object

A postal address

object

A postal address

object

A postal address

object

A postal address

hasSecondaryPickupAddress
boolean or null
hasSecondaryDeliveryAddress
boolean or null
object

A postal address

object

A postal address

hasTertiaryPickupAddress
boolean or null
hasTertiaryDeliveryAddress
boolean or null
actualProGearWeight
integer or null
actualSpouseProGearWeight
integer or null
destinationType
string or null (Destination Type)
Enum: "HOME_OF_RECORD" "HOME_OF_SELECTION" "PLACE_ENTERED_ACTIVE_DUTY" "OTHER_THAN_AUTHORIZED"
Array of objects (MTOAgents)
tacType
string (LOATypeNullable)
Enum: "HHG" "NTS"

The Line of accounting (TAC/SAC) type that will be used for the shipment

sacType
string (LOATypeNullable)
Enum: "HHG" "NTS"

The Line of accounting (TAC/SAC) type that will be used for the shipment

usesExternalVendor
boolean or null
serviceOrderNumber
string or null
ntsRecordedWeight
integer or null

The previously recorded weight for the NTS Shipment. Used for NTS Release to know what the previous primeActualWeight or billable weight was.

object (StorageFacility)

The Storage Facility information for the shipment

object (UpdatePPMShipment)
object (UpdateBoatShipment)
object (UpdateMobileHomeShipment)

Responses

Request samples

Content type
application/json
{
  • "shipmentType": "HHG",
  • "requestedPickupDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "counselor approved",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "secondaryPickupAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryDeliveryAddress": {
    },
  • "tertiaryPickupAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "agents": [
    ],
  • "tacType": "HHG",
  • "sacType": "HHG",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "ntsRecordedWeight": 2000,
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    }
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

shipment

Soft deletes a shipment by ID

Soft deletes a shipment by ID

path Parameters
shipmentID
required
string <uuid>

ID of the shipment to be deleted

Responses

Approves multiple shipments at once

Approves multiple shipments in one request

Request Body schema: application/json
required
Array of objects
Array
shipmentID
required
string <uuid>
eTag
required
string

Responses

Request samples

Content type
application/json
{
  • "approveShipments": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Approves a shipment

Approves a shipment

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string

Responses

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Requests a shipment diversion

Requests a shipment diversion

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string
Request Body schema: application/json
diversionReason
required
string

Responses

Request samples

Content type
application/json
{
  • "diversionReason": "Shipment route needs to change"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Approves a shipment diversion

Approves a shipment diversion

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string

Responses

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

rejects a shipment

rejects a shipment

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string
Request Body schema: application/json
rejectionReason
required
string

Responses

Request samples

Content type
application/json
{
  • "rejectionReason": "MTO Shipment not good enough"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Requests a shipment cancellation

Requests a shipment cancellation

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string

Responses

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Requests a shipment reweigh

Requests a shipment reweigh

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "requestedBy": "CUSTOMER",
  • "shipmentID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "verificationProvidedAt": "2019-08-24T14:15:22Z",
  • "verificationReason": "The reweigh was not performed due to some justification provided by the counselor",
  • "weight": 2000
}

Allows TOO to review a shipment address update

This endpoint is used to approve a address update request. Office remarks are required. Approving the address update will update the Destination Final Address of the associated service item

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string
Request Body schema: application/json
status
required
string
Enum: "REJECTED" "APPROVED"
officeRemarks
required
string

Responses

Request samples

Content type
application/json
{
  • "status": "REJECTED",
  • "officeRemarks": "string"
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "contractorRemarks": "This is a contractor remark",
  • "officeRemarks": "This is an office remark",
  • "status": "REQUESTED",
  • "shipmentID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "originalAddress": {
    },
  • "newAddress": {
    },
  • "sitOriginalAddress": {
    },
  • "oldSitDistanceBetween": 50,
  • "newSitDistanceBetween": 88
}

Create an approved SIT Duration Update

TOO can creates an already-approved SIT Duration Update on behalf of a customer

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string

We want the shipment's eTag rather than the SIT Duration Update eTag as the SIT Duration Update is always associated with a shipment

Request Body schema: application/json
requestReason
required
string
Enum: "SERIOUS_ILLNESS_MEMBER" "SERIOUS_ILLNESS_DEPENDENT" "IMPENDING_ASSIGNEMENT" "DIRECTED_TEMPORARY_DUTY" "NONAVAILABILITY_OF_CIVILIAN_HOUSING" "AWAITING_COMPLETION_OF_RESIDENCE" "OTHER"

Reason from service counselor-provided picklist for SIT Duration Update

approvedDays
required
integer

Number of days approved for SIT extension. This will match requested days saved to the SIT extension model.

officeRemarks
string or null

Remarks from TOO about SIT Duration Update creation

Responses

Request samples

Content type
application/json
{
  • "requestReason": "AWAITING_COMPLETION_OF_RESIDENCE",
  • "approvedDays": 21,
  • "officeRemarks": "Customer needs additional storage time as their new place of residence is not yet ready"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Approves a SIT extension

Approves a SIT extension

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

sitExtensionID
required
string <uuid>

ID of the SIT extension

header Parameters
If-Match
required
string

We want the shipment's eTag rather than the SIT extension eTag as the SIT extension is always associated with a shipment

Request Body schema: application/json
approvedDays
required
integer >= 1

Number of days approved for SIT extension

requestReason
string
Enum: "SERIOUS_ILLNESS_MEMBER" "SERIOUS_ILLNESS_DEPENDENT" "IMPENDING_ASSIGNEMENT" "DIRECTED_TEMPORARY_DUTY" "NONAVAILABILITY_OF_CIVILIAN_HOUSING" "AWAITING_COMPLETION_OF_RESIDENCE" "OTHER"

Reason from service counselor-provided picklist for SIT Duration Update

officeRemarks
string or null

Remarks from TOO about SIT approval

Responses

Request samples

Content type
application/json
{
  • "approvedDays": 21,
  • "requestReason": "AWAITING_COMPLETION_OF_RESIDENCE",
  • "officeRemarks": "Approved for three weeks rather than requested 45 days"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Denies a SIT extension

Denies a SIT extension

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

sitExtensionID
required
string <uuid>

ID of the SIT extension

header Parameters
If-Match
required
string
Request Body schema: application/json
officeRemarks
required
string or null

Remarks from TOO about SIT denial

convertToCustomerExpense
required
boolean

Whether or not to convert to members expense once SIT extension is denied.

Responses

Request samples

Content type
application/json
{
  • "officeRemarks": "Denied this extension as it does not match the criteria",
  • "convertToCustomerExpense": false
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Converts a SIT to customer expense

Converts a SIT to customer expense

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string
Request Body schema: application/json
convertToCustomerExpense
required
boolean
customerExpenseReason
required
string

Reason the service item was rejected

Responses

Request samples

Content type
application/json
{
  • "convertToCustomerExpense": true,
  • "customerExpenseReason": "Insufficent details provided"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

mtoAgent

Fetch move task order agents.

Fetches a list of agents associated with a move task order.

path Parameters
moveTaskOrderID
required
string <uuid>

ID of move task order

shipmentID
required
string <uuid>

ID of the shipment

Responses

Response samples

Content type
application/json
[
  • {
    }
]

paymentServiceItem

Change the status of a payment service item for a move by ID

Changes the status of a line item for a move by ID

path Parameters
moveTaskOrderID
required
string

ID of move to use

paymentServiceItemID
required
string

ID of payment service item to use

header Parameters
If-Match
required
string
Request Body schema: application/json
createdAt
string <date-time>
paymentRequestID
string <uuid>
mtoServiceItemID
string <uuid>
mtoServiceItemCode
string
mtoServiceItemName
string
mtoShipmentType
string (Shipment Type)
Enum: "HHG" "HHG_INTO_NTS" "HHG_OUTOF_NTS" "PPM" "BOAT_HAUL_AWAY" "BOAT_TOW_AWAY" "MOBILE_HOME" "UNACCOMPANIED_BAGGAGE"
mtoShipmentID
string or null <uuid>
status
string (Payment Service Item Status)
Enum: "REQUESTED" "APPROVED" "DENIED" "SENT_TO_GEX" "PAID" "EDI_ERROR"
priceCents
integer or null <cents> (Price of the service item in cents)
rejectionReason
string or null
Array of objects (PaymentServiceItemParams)
eTag
string
tppsInvoiceAmountPaidPerServiceItemMillicents
integer or null <millicents> (Amount that TPPS paid for the individual service item in millicents)

Responses

Request samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "paymentRequestID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "mtoServiceItemID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "mtoServiceItemCode": "DLH",
  • "mtoServiceItemName": "Move management",
  • "mtoShipmentType": "HHG",
  • "mtoShipmentID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "status": "REQUESTED",
  • "priceCents": 0,
  • "rejectionReason": "documentation was incomplete",
  • "paymentServiceItemParams": [
    ],
  • "eTag": "string",
  • "tppsInvoiceAmountPaidPerServiceItemMillicents": 0
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "paymentRequestID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "mtoServiceItemID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "mtoServiceItemCode": "DLH",
  • "mtoServiceItemName": "Move management",
  • "mtoShipmentType": "HHG",
  • "mtoShipmentID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "status": "REQUESTED",
  • "priceCents": 0,
  • "rejectionReason": "documentation was incomplete",
  • "referenceID": "1234-5678-c56a4180",
  • "paymentServiceItemParams": [
    ],
  • "eTag": "string",
  • "tppsInvoiceAmountPaidPerServiceItemMillicents": 0
}

ppm

Gets all the PPM documents for a PPM shipment

Retrieves all of the documents and associated uploads for each ppm document type connected to a PPM shipment. This excludes any deleted PPM documents.

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

Responses

Response samples

Content type
application/json
{
  • "WeightTickets": [
    ],
  • "ProGearWeightTickets": [
    ],
  • "MovingExpenses": [
    ]
}

Create a new upload for a PPM weight ticket, pro-gear, or moving expense document

Uploads represent a single digital file, such as a PNG, JPEG, PDF, or spreadsheet.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the ppm shipment

query Parameters
documentId
required
string <uuid>

UUID of the document to add an upload to

weightReceipt
required
boolean

If the upload is a Weight Receipt

Request Body schema: multipart/form-data
file
required
string <binary>

The file to upload.

Responses

Creates a weight ticket document

Created a weight ticket document with the given information

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

Responses

Updates a weight ticket document

Updates a PPM shipment's weight ticket document with new information. Only some of the weight ticket document's fields are editable because some have to be set by the customer, e.g. vehicle description.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

weightTicketId
required
string <uuid>

UUID of the weight ticket

header Parameters
If-Match
required
string

Optimistic locking is implemented via the If-Match header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a 412 Precondition Failed error.

Request Body schema: application/json
vehicleDescription
string or null

Description of the vehicle used for the trip. E.g. make/model, type of truck/van, etc.

emptyWeight
integer >= 0

Weight of the vehicle when empty.

missingEmptyWeightTicket
boolean or null

Indicates if the customer is missing a weight ticket for the vehicle weight when empty.

fullWeight
integer >= 0

The weight of the vehicle when full.

missingFullWeightTicket
boolean or null

Indicates if the customer is missing a weight ticket for the vehicle weight when full.

ownsTrailer
boolean

Indicates if the customer used a trailer they own for the move.

trailerMeetsCriteria
boolean

Indicates if the trailer that the customer used meets all the criteria to be claimable.

status
string (PPMDocumentStatus)
Enum: "APPROVED" "EXCLUDED" "REJECTED"

Status of the PPM document.

reason
string

The reason the services counselor has excluded or rejected the item.

adjustedNetWeight
integer >= 0

Indicates the adjusted net weight of the vehicle

netWeightRemarks
string

Remarks explaining any edits made to the net weight

Responses

Request samples

Content type
application/json
{
  • "vehicleDescription": "string",
  • "emptyWeight": 0,
  • "missingEmptyWeightTicket": true,
  • "fullWeight": 0,
  • "missingFullWeightTicket": true,
  • "ownsTrailer": true,
  • "trailerMeetsCriteria": true,
  • "status": "APPROVED",
  • "reason": "string",
  • "adjustedNetWeight": 0,
  • "netWeightRemarks": "string"
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "ppmShipmentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "vehicleDescription": "string",
  • "emptyWeight": 0,
  • "submittedEmptyWeight": 0,
  • "missingEmptyWeightTicket": true,
  • "emptyDocumentId": "dd4b5899-fcf2-4fcb-b1ed-3b2a01763ae1",
  • "emptyDocument": {
    },
  • "fullWeight": 0,
  • "submittedFullWeight": 0,
  • "missingFullWeightTicket": true,
  • "fullDocumentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "fullDocument": {
    },
  • "ownsTrailer": true,
  • "submittedOwnsTrailer": true,
  • "trailerMeetsCriteria": true,
  • "submittedTrailerMeetsCriteria": true,
  • "proofOfTrailerOwnershipDocumentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "proofOfTrailerOwnershipDocument": {
    },
  • "status": "APPROVED",
  • "reason": "string",
  • "adjustedNetWeight": 0,
  • "netWeightRemarks": "string",
  • "eTag": "string"
}

Soft deletes a weight ticket by ID

Removes a single weight ticket from the closeout line items for a PPM shipment. Soft deleted records are not visible in milmove, but are kept in the database. This may change the PPM shipment's final incentive.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

weightTicketId
required
string <uuid>

ID of the weight ticket to be deleted

Responses

Updates the moving expense

Updates a PPM shipment's moving expense with new information. Only some of the moving expense's fields are editable because some have to be set by the customer, e.g. the description and the moving expense type.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

movingExpenseId
required
string <uuid>

UUID of the moving expense

header Parameters
If-Match
required
string

Optimistic locking is implemented via the If-Match header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a 412 Precondition Failed error.

Request Body schema: application/json
movingExpenseType
string or null (OmittableMovingExpenseType)
Enum: "CONTRACTED_EXPENSE" "GAS" "OIL" "OTHER" "PACKING_MATERIALS" "RENTAL_EQUIPMENT" "STORAGE" "TOLLS" "WEIGHING_FEE"

Moving Expense Type

description
string or null

A brief description of the expense.

amount
integer

The total amount of the expense as indicated on the receipt

sitStartDate
string <date>

The date the shipment entered storage, applicable for the STORAGE movingExpenseType only

sitEndDate
string <date>

The date the shipment exited storage, applicable for the STORAGE movingExpenseType only

status
string (PPMDocumentStatus)
Enum: "APPROVED" "EXCLUDED" "REJECTED"

Status of the PPM document.

reason
string

The reason the services counselor has excluded or rejected the item.

weightStored
integer

The total weight stored in PPM SIT

sitLocation
string or null
Enum: "ORIGIN" "DESTINATION"

The list of SIT location types.

sitEstimatedCost
integer or null <cents>

The estimated amount that the government will pay the service member to put their goods into storage. This estimated storage cost is separate from the estimated incentive.

sitReimburseableAmount
integer or null <cents>

The amount of SIT that will be reimbursed

Responses

Request samples

Content type
application/json
{
  • "movingExpenseType": "CONTRACTED_EXPENSE",
  • "description": "string",
  • "amount": 0,
  • "sitStartDate": "2019-08-24",
  • "sitEndDate": "2019-08-24",
  • "status": "APPROVED",
  • "reason": "string",
  • "weightStored": 0,
  • "sitLocation": "ORIGIN",
  • "sitEstimatedCost": 0,
  • "sitReimburseableAmount": 0
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "ppmShipmentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "documentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "document": {
    },
  • "movingExpenseType": "CONTRACTED_EXPENSE",
  • "submittedMovingExpenseType": "CONTRACTED_EXPENSE",
  • "description": "string",
  • "submittedDescription": "string",
  • "paidWithGtcc": true,
  • "amount": 0,
  • "submittedAmount": 0,
  • "missingReceipt": true,
  • "status": "APPROVED",
  • "reason": "string",
  • "sitStartDate": "2022-04-26",
  • "submittedSitStartDate": "2022-04-26",
  • "sitEndDate": "2018-05-26",
  • "submittedSitEndDate": "2018-05-26",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eTag": "string",
  • "weightStored": 0,
  • "sitLocation": "ORIGIN",
  • "sitEstimatedCost": 0,
  • "sitReimburseableAmount": 0
}

Creates a pro-gear weight ticket

Creates a PPM shipment's pro-gear weight ticket. This will only contain the minimum necessary fields for a pro-gear weight ticket. Data should be filled in using the patch endpoint.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "ppmShipmentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "belongsToSelf": true,
  • "submittedBelongsToSelf": true,
  • "description": "string",
  • "hasWeightTickets": true,
  • "submittedHasWeightTickets": true,
  • "weight": 0,
  • "submittedWeight": 0,
  • "documentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "document": {
    },
  • "status": "APPROVED",
  • "reason": "string",
  • "eTag": "string"
}

Updates a pro-gear weight ticket

Updates a PPM shipment's pro-gear weight ticket with new information. Only some of the fields are editable because some have to be set by the customer, e.g. the description.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

proGearWeightTicketId
required
string <uuid>

UUID of the pro-gear weight ticket

header Parameters
If-Match
required
string

Optimistic locking is implemented via the If-Match header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a 412 Precondition Failed error.

Request Body schema: application/json
belongsToSelf
boolean

Indicates if this information is for the customer's own pro-gear, otherwise, it's the spouse's.

hasWeightTickets
boolean

Indicates if the user has a weight ticket for their pro-gear, otherwise they have a constructed weight.

weight
integer >= 0

Weight of the pro-gear contained in the shipment.

status
string (PPMDocumentStatus)
Enum: "APPROVED" "EXCLUDED" "REJECTED"

Status of the PPM document.

reason
string

The reason the services counselor has excluded or rejected the item.

description
string

Description of pro gear included in trips set.

Responses

Request samples

Content type
application/json
{
  • "belongsToSelf": true,
  • "hasWeightTickets": true,
  • "weight": 0,
  • "status": "APPROVED",
  • "reason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "ppmShipmentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "belongsToSelf": true,
  • "submittedBelongsToSelf": true,
  • "description": "string",
  • "hasWeightTickets": true,
  • "submittedHasWeightTickets": true,
  • "weight": 0,
  • "submittedWeight": 0,
  • "documentId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "document": {
    },
  • "status": "APPROVED",
  • "reason": "string",
  • "eTag": "string"
}

Soft deletes a pro-gear weight line item by ID

Removes a single pro-gear weight ticket set from the closeout line items for a PPM shipment. Soft deleted records are not visible in milmove, but are kept in the database.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

proGearWeightTicketId
required
string <uuid>

ID of the pro-gear weight ticket to be deleted

Responses

Downloads AOA Packet form PPMShipment as a PDF

Functionality

This endpoint downloads all uploaded move order documentation combined with the Shipment Summary Worksheet into a single PDF.

Errors

  • The PPMShipment must have requested an AOA.
  • The PPMShipment AOA Request must have been approved.
path Parameters
ppmShipmentId
required
string

the id for the ppmshipment with aoa to be downloaded

Responses

Updates a PPM shipment's status after document review

Updates a PPM shipment's status once documents have been reviewed. Status is updated depending on whether any documents have been rejected.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

header Parameters
If-Match
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "ppmType": "INCENTIVE_BASED",
  • "shipmentId": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "DRAFT",
  • "w2Address": {
    },
  • "advanceStatus": "APPROVED",
  • "expectedDepartureDate": "2019-08-24",
  • "actualMoveDate": "2019-08-24",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "reviewedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "pickupAddress": {
    },
  • "secondaryPickupAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "actualPickupPostalCode": "90210",
  • "destinationAddress": {
    },
  • "secondaryDestinationAddress": {
    },
  • "hasSecondaryDestinationAddress": true,
  • "tertiaryDestinationAddress": {
    },
  • "hasTertiaryDestinationAddress": true,
  • "actualDestinationPostalCode": "90210",
  • "sitExpected": true,
  • "estimatedWeight": 4200,
  • "allowableWeight": 4300,
  • "hasProGear": true,
  • "proGearWeight": 0,
  • "spouseProGearWeight": 0,
  • "estimatedIncentive": 0,
  • "maxIncentive": 0,
  • "finalIncentive": 0,
  • "hasRequestedAdvance": true,
  • "advanceAmountRequested": 0,
  • "hasReceivedAdvance": true,
  • "advanceAmountReceived": 0,
  • "sitLocation": "ORIGIN",
  • "sitEstimatedWeight": 2000,
  • "sitEstimatedEntryDate": "2019-08-24",
  • "sitEstimatedDepartureDate": "2019-08-24",
  • "sitEstimatedCost": 0,
  • "weightTickets": [
    ],
  • "movingExpenses": [
    ],
  • "proGearWeightTickets": [
    ],
  • "isActualExpenseReimbursement": false,
  • "signedCertification": {
    },
  • "eTag": "string"
}

Updates a PPM shipment's SIT values

Updates a PPM shipment's SIT values

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

header Parameters
If-Match
required
string
Request Body schema: application/json
sitLocation
required
string or null
Enum: "ORIGIN" "DESTINATION"

The list of SIT location types.

Responses

Request samples

Content type
application/json
{
  • "sitLocation": "ORIGIN"
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "ppmType": "INCENTIVE_BASED",
  • "shipmentId": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "status": "DRAFT",
  • "w2Address": {
    },
  • "advanceStatus": "APPROVED",
  • "expectedDepartureDate": "2019-08-24",
  • "actualMoveDate": "2019-08-24",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "reviewedAt": "2019-08-24T14:15:22Z",
  • "approvedAt": "2019-08-24T14:15:22Z",
  • "pickupAddress": {
    },
  • "secondaryPickupAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "actualPickupPostalCode": "90210",
  • "destinationAddress": {
    },
  • "secondaryDestinationAddress": {
    },
  • "hasSecondaryDestinationAddress": true,
  • "tertiaryDestinationAddress": {
    },
  • "hasTertiaryDestinationAddress": true,
  • "actualDestinationPostalCode": "90210",
  • "sitExpected": true,
  • "estimatedWeight": 4200,
  • "allowableWeight": 4300,
  • "hasProGear": true,
  • "proGearWeight": 0,
  • "spouseProGearWeight": 0,
  • "estimatedIncentive": 0,
  • "maxIncentive": 0,
  • "finalIncentive": 0,
  • "hasRequestedAdvance": true,
  • "advanceAmountRequested": 0,
  • "hasReceivedAdvance": true,
  • "advanceAmountReceived": 0,
  • "sitLocation": "ORIGIN",
  • "sitEstimatedWeight": 2000,
  • "sitEstimatedEntryDate": "2019-08-24",
  • "sitEstimatedDepartureDate": "2019-08-24",
  • "sitEstimatedCost": 0,
  • "weightTickets": [
    ],
  • "movingExpenses": [
    ],
  • "proGearWeightTickets": [
    ],
  • "isActualExpenseReimbursement": false,
  • "signedCertification": {
    },
  • "eTag": "string"
}

Get the closeout calcuations for the specified PPM shipment

Retrieves the closeout calculations for the specified PPM shipment.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "plannedMoveDate": "2019-08-24",
  • "actualMoveDate": "2019-08-24",
  • "miles": 54,
  • "estimatedWeight": 4200,
  • "actualWeight": 2000,
  • "proGearWeightCustomer": 0,
  • "proGearWeightSpouse": 0,
  • "grossIncentive": 0,
  • "gcc": 0,
  • "aoa": 0,
  • "remainingIncentive": 0,
  • "haulType": "string",
  • "haulPrice": 0,
  • "haulFSC": 0,
  • "dop": 0,
  • "ddp": 0,
  • "packPrice": 0,
  • "unpackPrice": 0,
  • "intlPackPrice": 0,
  • "intlUnpackPrice": 0,
  • "intlLinehaulPrice": 0,
  • "SITReimbursement": 0
}

Get the actual weight for a PPM shipment

Retrieves the actual weight for the specified PPM shipment.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

Responses

Response samples

Content type
application/json
{
  • "actualWeight": 2000
}

Get the SIT estimated cost for a PPM shipment

Calculates and returns the SIT estimated cost for the specified PPM shipment.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the PPM shipment

sitLocation
required
string <string>
Enum: "ORIGIN" "DESTINATION"

location of sit

query Parameters
sitEntryDate
required
string <date-time>

Date entered into SIT

sitDepartureDate
required
string <date-time>

Date departed SIT

weightStored
required
integer >= 0

Weight stored in SIT

Responses

Response samples

Content type
application/json
{
  • "sitCost": 2000,
  • "priceFirstDaySIT": 2000,
  • "priceAdditionalDaySIT": 2000,
  • "paramsFirstDaySIT": {
    },
  • "paramsAdditionalDaySIT": {
    }
}

Returns PPM payment packet

Generates a PDF containing all user uploaded documentations for PPM. Contains SSW form, orders, weight and expense documentations.

path Parameters
ppmShipmentId
required
string <uuid>

UUID of the ppmShipment

Responses

tac

Validation of a TAC value

Returns a boolean based on whether a tac value is valid or not

query Parameters
tac
required
string

The tac value to validate

Responses

transportationOffice

Returns the transportation offices matching the search query that is enabled for PPM closeout

Returns the transportation offices matching the search query that is enabled for PPM closeout

query Parameters
search
required
string >= 2 characters

Search string for transportation offices

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns the transportation offices matching the search query

This endpoint is publicly accessible as it is utilized to access transportation office information without having an office account.Returns the transportation offices matching the search query.

query Parameters
search
required
string >= 2 characters

Search string for transportation offices

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of distinct GBLOCs that exist in the transportation offices table

Returns a list of distinct GBLOCs that exist in the transportation offices table

Responses

Response samples

Content type
application/json
[
  • "string"
]

Returns the counseling locations in the GBLOC matching the duty location

Returns the counseling locations matching the GBLOC from the selected duty location

path Parameters
dutyLocationId
required
string <uuid>

UUID of the duty location

serviceMemberId
required
string <uuid>

UUID of the service member, some counseling offices are branch specific

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addresses

Returns city, state, postal code, and county associated with the specified full/partial postal code or city and state string

Find by API using full/partial postal code or city name that returns an us_post_region_cities json object containing city, state, county and postal code.

path Parameters
search
required
string

Responses

uploads

Create a new upload

Uploads represent a single digital file, such as a JPEG or PDF. Currently, office application uploads are only for Services Counselors to upload files for orders, but this may be expanded in the future.

query Parameters
documentId
string <uuid>

UUID of the document to add an upload to

Request Body schema: multipart/form-data
file
required
string <binary>

The file to upload.

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "url": "https://uploads.domain.test/dir/c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "filename": "filename.pdf",
  • "contentType": "application/pdf",
  • "bytes": 0,
  • "rotation": 2,
  • "status": "INFECTED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "isWeightTicket": true,
  • "uploadType": "OFFICE"
}

Deletes an upload

Uploads represent a single digital file, such as a JPEG or PDF.

path Parameters
uploadID
required
string <uuid>

UUID of the upload to be deleted

query Parameters
orderID
string <uuid>

ID of the order that the upload belongs to

Responses

Gets an upload by ID

Gets an upload

Responses

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "url": "https://uploads.domain.test/dir/c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "filename": "filename.pdf",
  • "contentType": "application/pdf",
  • "bytes": 0,
  • "rotation": 2,
  • "status": "INFECTED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "isWeightTicket": true,
  • "uploadType": "OFFICE"
}

Update an existing upload. This is only needed currently for updating the image rotation.

Uploads represent a single digital file, such as a JPEG or PDF. The rotation is relevant to how it is displayed on the page.

path Parameters
uploadID
required
string <uuid>

UUID of the upload to be updated

Request Body schema: application/json
rotation
integer [ 0 .. 3 ]

The rotation of the image

Responses

Request samples

Content type
application/json
{
  • "rotation": 3
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "url": "https://uploads.domain.test/dir/c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "filename": "filename.pdf",
  • "contentType": "application/pdf",
  • "bytes": 0,
  • "rotation": 2,
  • "status": "INFECTED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "isWeightTicket": true,
  • "uploadType": "OFFICE"
}

Returns status of an upload

Returns status of an upload based on antivirus run

path Parameters
uploadID
required
string <uuid>

UUID of the upload to return status of

Responses

paymentRequests

Fetches a payment request by id

Fetches an instance of a payment request by id

path Parameters
paymentRequestID
required
string <uuid>

UUID of payment request

Responses

Response samples

Content type
application/json
{
  • "proofOfServiceDocs": [
    ],
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "isFinal": false,
  • "moveTaskOrder": {
    },
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "rejectionReason": "documentation was incomplete",
  • "serviceItems": [
    ],
  • "status": "PENDING",
  • "paymentRequestNumber": "1234-5678-1",
  • "recalculationOfPaymentRequestID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "eTag": "string",
  • "reviewedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sentToGexAt": "2019-08-24T14:15:22Z",
  • "receivedByGexAt": "2019-08-24T14:15:22Z",
  • "ediErrorType": "string",
  • "ediErrorCode": "string",
  • "ediErrorDescription": "string",
  • "tppsInvoiceAmountPaidTotalMillicents": 0,
  • "tppsInvoiceSellerPaidDate": "2019-08-24T14:15:22Z"
}

Fetches payment requests using the move code (locator).

Fetches payment requests for a move

path Parameters
locator
required
string <string>

move code to identify a move for payment requests

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns all shipment payment request SIT usage to support partial SIT invoicing

Returns all shipment payment request SIT usage to support partial SIT invoicing

path Parameters
paymentRequestID
required
string <uuid>

payment request ID of the payment request with SIT service items being reviewed

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates status of a payment request by id

Updates status of a payment request by id

path Parameters
paymentRequestID
required
string <uuid>

UUID of payment request

header Parameters
If-Match
required
string
Request Body schema: application/json
rejectionReason
string or null
status
string (Payment Request Status)
Enum: "PENDING" "REVIEWED" "REVIEWED_AND_ALL_SERVICE_ITEMS_REJECTED" "SENT_TO_GEX" "TPPS_RECEIVED" "PAID" "EDI_ERROR" "DEPRECATED"
eTag
string

Responses

Request samples

Content type
application/json
{
  • "rejectionReason": "documentation was incomplete",
  • "status": "PENDING",
  • "eTag": "string"
}

Response samples

Content type
application/json
{
  • "proofOfServiceDocs": [
    ],
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "isFinal": false,
  • "moveTaskOrder": {
    },
  • "moveTaskOrderID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "rejectionReason": "documentation was incomplete",
  • "serviceItems": [
    ],
  • "status": "PENDING",
  • "paymentRequestNumber": "1234-5678-1",
  • "recalculationOfPaymentRequestID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "eTag": "string",
  • "reviewedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sentToGexAt": "2019-08-24T14:15:22Z",
  • "receivedByGexAt": "2019-08-24T14:15:22Z",
  • "ediErrorType": "string",
  • "ediErrorCode": "string",
  • "ediErrorDescription": "string",
  • "tppsInvoiceAmountPaidTotalMillicents": 0,
  • "tppsInvoiceSellerPaidDate": "2019-08-24T14:15:22Z"
}

Downloads all Payment Request documents as a PDF

This endpoint downloads all uploaded payment request documentation combined into a single PDF.

path Parameters
paymentRequestID
required
string

the id for the payment-request with files to be downloaded

Responses

reServiceItems

Returns all ReServiceItems (Service Code, Service Name, Market, Shipment Type, Auto Approved)

Get ReServiceItems

Responses

Response samples

Content type
application/json
[
  • {
    }
]

officeUsers

Create an Office User

This endpoint is publicly accessible as it is utilized for individuals who do not have an office account to request the creation of an office account. Request the creation of an office user. An administrator will need to approve them after creation. Note on requirements: An identification method must be present. The following 2 fields have an "OR" requirement. - edipi - other_unique_id One of these two fields MUST be present to serve as identification for the office user being created. This logic is handled at the application level.

Request Body schema: application/json

Office User information

email
required
string (Email)
edipi
string or null (EDIPI) <= 10 characters
otherUniqueId
string or null (Office user identifier when EDIPI is not available)
firstName
required
string (First Name)
middleInitials
string or null (Middle Initials)
lastName
required
string (Last Name)
telephone
required
string <telephone> ^[2-9]\d{2}-\d{3}-\d{4}$
transportationOfficeId
required
string <uuid>
required
Array of objects (OfficeUserRole)

Responses

Request samples

Content type
application/json
{
  • "email": "user@userdomain.com",
  • "edipi": "1234567890",
  • "otherUniqueId": "string",
  • "firstName": "string",
  • "middleInitials": "L.",
  • "lastName": "string",
  • "telephone": "212-555-5555",
  • "transportationOfficeId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "middleInitials": "string",
  • "lastName": "string",
  • "email": "string",
  • "telephone": "string",
  • "transportationOfficeId": "bdde73b3-4d28-4f91-a4f4-26eb5999a45c",
  • "transportationOffice": {
    },
  • "transportationOfficeAssignments": [
    ],
  • "active": true,
  • "roles": [
    ],
  • "edipi": "string",
  • "otherUniqueId": "string",
  • "rejectionReason": "string",
  • "status": "APPROVED",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

reweigh

Requests a shipment reweigh

Requests a shipment reweigh

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "requestedAt": "2019-08-24T14:15:22Z",
  • "requestedBy": "CUSTOMER",
  • "shipmentID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "verificationProvidedAt": "2019-08-24T14:15:22Z",
  • "verificationReason": "The reweigh was not performed due to some justification provided by the counselor",
  • "weight": 2000
}

shipment_address_updates

Allows TOO to review a shipment address update

This endpoint is used to approve a address update request. Office remarks are required. Approving the address update will update the Destination Final Address of the associated service item

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string
Request Body schema: application/json
status
required
string
Enum: "REJECTED" "APPROVED"
officeRemarks
required
string

Responses

Request samples

Content type
application/json
{
  • "status": "REJECTED",
  • "officeRemarks": "string"
}

Response samples

Content type
application/json
{
  • "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "contractorRemarks": "This is a contractor remark",
  • "officeRemarks": "This is an office remark",
  • "status": "REQUESTED",
  • "shipmentID": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  • "originalAddress": {
    },
  • "newAddress": {
    },
  • "sitOriginalAddress": {
    },
  • "oldSitDistanceBetween": 50,
  • "newSitDistanceBetween": 88
}

sitExtension

Create an approved SIT Duration Update

TOO can creates an already-approved SIT Duration Update on behalf of a customer

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

header Parameters
If-Match
required
string

We want the shipment's eTag rather than the SIT Duration Update eTag as the SIT Duration Update is always associated with a shipment

Request Body schema: application/json
requestReason
required
string
Enum: "SERIOUS_ILLNESS_MEMBER" "SERIOUS_ILLNESS_DEPENDENT" "IMPENDING_ASSIGNEMENT" "DIRECTED_TEMPORARY_DUTY" "NONAVAILABILITY_OF_CIVILIAN_HOUSING" "AWAITING_COMPLETION_OF_RESIDENCE" "OTHER"

Reason from service counselor-provided picklist for SIT Duration Update

approvedDays
required
integer

Number of days approved for SIT extension. This will match requested days saved to the SIT extension model.

officeRemarks
string or null

Remarks from TOO about SIT Duration Update creation

Responses

Request samples

Content type
application/json
{
  • "requestReason": "AWAITING_COMPLETION_OF_RESIDENCE",
  • "approvedDays": 21,
  • "officeRemarks": "Customer needs additional storage time as their new place of residence is not yet ready"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Approves a SIT extension

Approves a SIT extension

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

sitExtensionID
required
string <uuid>

ID of the SIT extension

header Parameters
If-Match
required
string

We want the shipment's eTag rather than the SIT extension eTag as the SIT extension is always associated with a shipment

Request Body schema: application/json
approvedDays
required
integer >= 1

Number of days approved for SIT extension

requestReason
string
Enum: "SERIOUS_ILLNESS_MEMBER" "SERIOUS_ILLNESS_DEPENDENT" "IMPENDING_ASSIGNEMENT" "DIRECTED_TEMPORARY_DUTY" "NONAVAILABILITY_OF_CIVILIAN_HOUSING" "AWAITING_COMPLETION_OF_RESIDENCE" "OTHER"

Reason from service counselor-provided picklist for SIT Duration Update

officeRemarks
string or null

Remarks from TOO about SIT approval

Responses

Request samples

Content type
application/json
{
  • "approvedDays": 21,
  • "requestReason": "AWAITING_COMPLETION_OF_RESIDENCE",
  • "officeRemarks": "Approved for three weeks rather than requested 45 days"
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

Denies a SIT extension

Denies a SIT extension

path Parameters
shipmentID
required
string <uuid>

ID of the shipment

sitExtensionID
required
string <uuid>

ID of the SIT extension

header Parameters
If-Match
required
string
Request Body schema: application/json
officeRemarks
required
string or null

Remarks from TOO about SIT denial

convertToCustomerExpense
required
boolean

Whether or not to convert to members expense once SIT extension is denied.

Responses

Request samples

Content type
application/json
{
  • "officeRemarks": "Denied this extension as it does not match the criteria",
  • "convertToCustomerExpense": false
}

Response samples

Content type
application/json
{
  • "moveTaskOrderID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "primeEstimatedWeight": 2000,
  • "primeActualWeight": 2000,
  • "calculatedBillableWeight": 2000,
  • "ntsRecordedWeight": 2000,
  • "scheduledPickupDate": "2019-08-24",
  • "scheduledDeliveryDate": "2019-08-24",
  • "requestedPickupDate": "2019-08-24",
  • "actualPickupDate": "2019-08-24",
  • "actualDeliveryDate": "2019-08-24",
  • "requestedDeliveryDate": "2019-08-24",
  • "requiredDeliveryDate": "2019-08-24",
  • "approvedDate": "2019-08-24T14:15:22Z",
  • "diversion": true,
  • "diversionReason": "MTO Shipment needs rerouted",
  • "distance": 500,
  • "pickupAddress": {
    },
  • "destinationAddress": {
    },
  • "destinationType": "OTHER_THAN_AUTHORIZED",
  • "secondaryPickupAddress": {
    },
  • "secondaryDeliveryAddress": {
    },
  • "hasSecondaryPickupAddress": true,
  • "hasSecondaryDeliveryAddress": true,
  • "tertiaryPickupAddress": {
    },
  • "tertiaryDeliveryAddress": {
    },
  • "hasTertiaryPickupAddress": true,
  • "hasTertiaryDeliveryAddress": true,
  • "actualProGearWeight": 0,
  • "actualSpouseProGearWeight": 0,
  • "customerRemarks": "handle with care",
  • "counselorRemarks": "handle with care",
  • "shipmentType": "HHG",
  • "status": "SUBMITTED",
  • "rejectionReason": "MTO Shipment not good enough",
  • "reweigh": {
    },
  • "mtoAgents": [
    ],
  • "mtoServiceItems": [
    ],
  • "sitDaysAllowance": 0,
  • "sitExtensions": [
    ],
  • "sitStatus": {
    },
  • "eTag": "string",
  • "billableWeightCap": 2500,
  • "billableWeightJustification": "more weight than expected",
  • "tacType": "string",
  • "sacType": "string",
  • "usesExternalVendor": false,
  • "serviceOrderNumber": "string",
  • "storageFacility": {
    },
  • "ppmShipment": {
    },
  • "boatShipment": {
    },
  • "mobileHomeShipment": {
    },
  • "deliveryAddressUpdate": {
    },
  • "shipmentLocator": "1K43AR-01",
  • "originSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "destinationSitAuthEndDate": "2019-08-24T14:15:22Z",
  • "marketCode": "d",
  • "podLocation": {
    },
  • "poeLocation": {
    }
}

customerSupportRemarks

Creates a customer support remark for a move

Creates a customer support remark for a move

path Parameters
locator
required
string <string>

move code to identify a move for customer support remarks

Request Body schema: application/json
content
required
string
officeUserID
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "content": "This is a remark about a move.",
  • "officeUserID": "1f2270c7-7166-40ae-981e-b200ebdf3054"
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "officeUserID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "moveID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "content": "This is a remark about a move.",
  • "officeUserFirstName": "Grace",
  • "officeUserLastName": "Griffin",
  • "officeUserEmail": "string"
}

Fetches customer support remarks using the move code (locator).

Fetches customer support remarks for a move

path Parameters
locator
required
string <string>

move code to identify a move for customer support remarks

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a customer support remark for a move

Updates a customer support remark for a move

path Parameters
customerSupportRemarkID
required
string <uuid>

the customer support remark ID to be modified

Request Body schema: application/json
content
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "This is a remark about a move."
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "officeUserID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "moveID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "content": "This is a remark about a move.",
  • "officeUserFirstName": "Grace",
  • "officeUserLastName": "Griffin",
  • "officeUserEmail": "string"
}

Soft deletes a customer support remark by ID

Soft deletes a customer support remark by ID

path Parameters
customerSupportRemarkID
required
string <uuid>

the customer support remark ID to be modified

Responses

evaluationReports

Creates an evaluation report

Creates an evaluation report

path Parameters
locator
required
string
Request Body schema: application/json
shipmentID
string <uuid>

The shipment ID of the shipment to be evaluated in the report

Responses

Request samples

Content type
application/json
{
  • "shipmentID": "01b9671e-b268-4906-967b-ba661a1d3933"
}

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "moveID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "shipmentID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "type": "SHIPMENT",
  • "inspectionType": "DATA_REVIEW",
  • "inspectionDate": "2019-08-24",
  • "officeUser": {
    },
  • "location": "ORIGIN",
  • "reportViolations": [
    ],
  • "gsrAppeals": [
    ],
  • "locationDescription": "Route 66 at crash inspection site 3",
  • "observedShipmentDeliveryDate": "2019-08-24",
  • "observedShipmentPhysicalPickupDate": "2019-08-24",
  • "timeDepart": "14:30",
  • "evalStart": "15:00",
  • "evalEnd": "18:00",
  • "violationsObserved": true,
  • "remarks": "string",
  • "seriousIncident": true,
  • "seriousIncidentDesc": "string",
  • "observedClaimsResponseDate": "2019-08-24",
  • "observedPickupDate": "2019-08-24",
  • "observedPickupSpreadStartDate": "2019-08-24",
  • "observedPickupSpreadEndDate": "2019-08-24",
  • "observedDeliveryDate": "2019-08-24",
  • "moveReferenceID": "string",
  • "eTag": "string",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Downloads an evaluation report as a PDF

Downloads an evaluation report as a PDF

path Parameters
reportID
required
string <uuid>

the evaluation report ID to be downloaded

Responses

Gets an evaluation report by ID

Gets an evaluation report by ID

path Parameters
reportID
required
string <uuid>

the evaluation report ID to be modified

Responses

Response samples

Content type
application/json
{
  • "id": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "moveID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "shipmentID": "1f2270c7-7166-40ae-981e-b200ebdf3054",
  • "type": "SHIPMENT",
  • "inspectionType": "DATA_REVIEW",
  • "inspectionDate": "2019-08-24",
  • "officeUser": {
    },
  • "location": "ORIGIN",
  • "reportViolations": [
    ],
  • "gsrAppeals": [
    ],
  • "locationDescription": "Route 66 at crash inspection site 3",
  • "observedShipmentDeliveryDate": "2019-08-24",
  • "observedShipmentPhysicalPickupDate": "2019-08-24",
  • "timeDepart": "14:30",
  • "evalStart": "15:00",
  • "evalEnd": "18:00",
  • "violationsObserved": true,
  • "remarks": "string",
  • "seriousIncident": true,
  • "seriousIncidentDesc": "string",
  • "observedClaimsResponseDate": "2019-08-24",
  • "observedPickupDate": "2019-08-24",
  • "observedPickupSpreadStartDate": "2019-08-24",
  • "observedPickupSpreadEndDate": "2019-08-24",
  • "observedDeliveryDate": "2019-08-24",
  • "moveReferenceID": "string",
  • "eTag": "string",
  • "submittedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes an evaluation report by ID

Deletes an evaluation report by ID

path Parameters
reportID
required
string <uuid>

the evaluation report ID to be modified

Responses

Saves an evaluation report as a draft

Saves an evaluation report as a draft

path Parameters
reportID
required
string <uuid>

the evaluation report ID to be modified

header Parameters
If-Match
required
string

Optimistic locking is implemented via the If-Match header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a 412 Precondition Failed error.

Request Body schema: application/json
type
string (EvaluationReportType)
Enum: "SHIPMENT" "COUNSELING"
inspectionType
string or null (EvaluationReportInspectionType)
Enum: "DATA_REVIEW" "PHYSICAL" "VIRTUAL"
inspectionDate
string or null <date>
location
string or null (EvaluationReportLocation)
Enum: "ORIGIN" "DESTINATION" "OTHER"
Array of objects (ReportViolations)
Array of objects (GSRAppeals)
locationDescription
string or null
observedShipmentDeliveryDate
string or null <date>
observedShipmentPhysicalPickupDate
string or null <date>
timeDepart
string or null^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
evalStart
string or null^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
evalEnd
string or null^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
violationsObserved
boolean or null
remarks
string or null
seriousIncident
boolean or null
seriousIncidentDesc
string or null
observedClaimsResponseDate
string or null <date>
observedPickupDate
string or null <date>
observedPickupSpreadStartDate
string or null <date>
observedPickupSpreadEndDate
string or null <date>
observedDeliveryDate
string or null <date>
eTag
string
submittedAt
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "type": "SHIPMENT",
  • "inspectionType": "DATA_REVIEW",
  • "inspectionDate": "2019-08-24",
  • "location": "ORIGIN",
  • "reportViolations": [
    ],
  • "gsrAppeals": [
    ],
  • "locationDescription": "Route 66 at crash inspection site 3",
  • "observedShipmentDeliveryDate": "2019-08-24",
  • "observedShipmentPhysicalPickupDate": "2019-08-24",
  • "timeDepart": "14:30",
  • "evalStart": "15:00",
  • "evalEnd": "18:00",
  • "violationsObserved": true,
  • "remarks": "string",
  • "seriousIncident": true,
  • "seriousIncidentDesc": "string",
  • "observedClaimsResponseDate": "2019-08-24",
  • "observedPickupDate": "2019-08-24",
  • "observedPickupSpreadStartDate": "2019-08-24",
  • "observedPickupSpreadEndDate": "2019-08-24",
  • "observedDeliveryDate": "2019-08-24",
  • "eTag": "string",
  • "submittedAt": "2019-08-24T14:15:22Z"
}

Submits an evaluation report

Submits an evaluation report

path Parameters
reportID
required
string <uuid>

the evaluation report ID to be modified

header Parameters
If-Match
required
string

Optimistic locking is implemented via the If-Match header. If the ETag header does not match the value of the resource on the server, the server rejects the change with a 412 Precondition Failed error.

Responses

Adds an appeal to a serious incident on an evaluation report

Adds an appeal to a serious incident on an evaluation report

path Parameters
reportID
required
string <uuid>

the evaluation report ID

Request Body schema: application/json
remarks
string

Remarks left by the GSR user

appealStatus
string
Enum: "sustained" "rejected"

The status of the appeal set by the GSR user

Responses

Request samples

Content type
application/json
{
  • "remarks": "These are my violation appeal remarks",
  • "appealStatus": "These are my violation appeal remarks"
}

Adds an appeal to a violation

Adds an appeal to a violation

path Parameters
reportID
required
string <uuid>

the evaluation report ID

reportViolationID
required
string <uuid>

the report violation ID

Request Body schema: application/json
remarks
string

Remarks left by the GSR user

appealStatus
string
Enum: "sustained" "rejected"

The status of the appeal set by the GSR user

Responses

Request samples

Content type
application/json
{
  • "remarks": "These are my violation appeal remarks",
  • "appealStatus": "These are my violation appeal remarks"
}

pwsViolations

Fetch the possible PWS violations for an evaluation report

Fetch the possible PWS violations for an evaluation report

Responses

Response samples

Content type
application/json
[
  • {
    }
]

reportViolations

Fetch the report violations for an evaluation report

Fetch the report violations for an evaluation report

path Parameters
reportID
required
string <uuid>

the evaluation report ID that has associated violations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Associate violations with an evaluation report

Associate violations with an evaluation report. This will overwrite any existing report-violations associations for the report and replace them with the newly provided ones. An empty array will remove all violation associations for a given report.

path Parameters
reportID
required
string <uuid>

the evaluation report ID that has associated violations

Request Body schema: application/json
violations
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "violations": [
    ]
}

ghcDocuments

Returns a document

Returns a document and its uploads

path Parameters
documentId
required
string <uuid>

UUID of the document to return

Responses

Create a new document

Documents represent a physical artifact such as a scanned document or a PDF file

Request Body schema: application/json
service_member_id
string <uuid> (The service member this document belongs to)

Responses

Request samples

Content type
application/json
{
  • "service_member_id": "7f649378-826f-482d-97df-10daed06e2e7"
}

linesOfAccounting

Fetch line of accounting

Fetches a line of accounting based on provided service member affiliation, effective date, and Transportation Accounting Code (TAC). It uses these parameters to filter the correct Line of Accounting for the provided TAC. It does this by filtering through both TAC and LOAs based on the provided code and effective date. The 'Effective Date' is the date that can be either the orders issued date (For HHG shipments), MTO approval date (For NTS shipments), or even the current date for NTS shipments with no approval yet (Just providing a preview to the office users per customer request). Effective date is used to find "Active" TGET data by searching for the TACs and LOAs with begin and end dates containing this date.

Request Body schema: application/json

Service member affiliation, effective date, and TAC code.

departmentIndicator
required
string or null (Department indicator)
Enum: "ARMY" "ARMY_CORPS_OF_ENGINEERS" "COAST_GUARD" "NAVY_AND_MARINES" "AIR_AND_SPACE_FORCE" "OFFICE_OF_SECRETARY_OF_DEFENSE"

Military branch of service indicator for orders

effectiveDate
required
string <date>

The effective date for the Line Of Accounting (LOA) being fetched. Eg, the orders issue date or the Non-Temporary Storage (NTS) Move Task Order (MTO) approval date. Effective date is used to find "Active" TGET data by searching for the TACs and LOAs with begin and end dates containing this date. The 'Effective Date' is the date that can be either the orders issued date (For HHG shipments), MTO approval date (For NTS shipments), or even the current date for NTS shipments with no approval yet (Just providing a preview to the office users per customer request).

tacCode
required
string = 4 characters

Responses

Request samples

Content type
application/json
{
  • "departmentIndicator": "ARMY",
  • "effectiveDate": "2023-01-01",
  • "tacCode": "F8J1"
}

Response samples

Content type
application/json
{
  • "id": "06254fc3-b763-484c-b555-42855d1ad5cd",
  • "loaSysId": "10003",
  • "loaDptID": "1 ",
  • "loaTnsfrDptNm": "stri",
  • "loaBafID": "1234",
  • "loaTrsySfxTx": "0000",
  • "loaMajClmNm": "stri",
  • "loaOpAgncyID": "1A",
  • "loaAlltSnID": "123A",
  • "loaPgmElmntID": "00000000",
  • "loaTskBdgtSblnTx": "string",
  • "loaDfAgncyAlctnRcpntID": "stri",
  • "loaJbOrdNm": "string",
  • "loaSbaltmtRcpntID": "s",
  • "loaWkCntrRcpntNm": "string",
  • "loaMajRmbsmtSrcID": "s",
  • "loaDtlRmbsmtSrcID": "str",
  • "loaCustNm": "string",
  • "loaObjClsID": "22NL",
  • "loaSrvSrcID": "s",
  • "loaSpclIntrID": "st",
  • "loaBdgtAcntClsNm": "000000",
  • "loaDocID": "HHG12345678900",
  • "loaClsRefID": "st",
  • "loaInstlAcntgActID": "12345",
  • "loaLclInstlID": "string",
  • "loaFmsTrnsactnID": "string",
  • "loaDscTx": "PERSONAL PROPERTY - PARANORMAL ACTIVITY DIVISION (OTHER)",
  • "loaBgnDt": "2005-10-01",
  • "loaEndDt": "2015-10-01",
  • "loaFnctPrsNm": "string",
  • "loaStatCd": "U",
  • "loaHistStatCd": "s",
  • "loaHsGdsCd": "HT",
  • "orgGrpDfasCd": "ZZ",
  • "loaUic": "string",
  • "loaTrnsnID": "B1",
  • "loaSubAcntID": "str",
  • "loaBetCd": "stri",
  • "loaFndTyFgCd": "s",
  • "loaBgtLnItmID": "string",
  • "loaScrtyCoopImplAgncCd": "s",
  • "loaScrtyCoopDsgntrCd": "stri",
  • "loaScrtyCoopLnItmID": "str",
  • "loaAgncDsbrCd": "string",
  • "loaAgncAcntngCd": "string",
  • "loaFndCntrID": "string",
  • "loaCstCntrID": "string",
  • "loaPrjID": "string",
  • "loaActvtyID": "string",
  • "loaCstCd": "string",
  • "loaWrkOrdID": "string",
  • "loaFnclArID": "string",
  • "loaScrtyCoopCustCd": "st",
  • "loaEndFyTx": 2016,
  • "loaBgFyTx": 2006,
  • "loaBgtRstrCd": "s",
  • "loaBgtSubActCd": "stri",
  • "createdAt": "2023-08-03T19:17:10.050Z",
  • "updatedAt": "2023-08-03T19:17:38.776Z",
  • "validLoaForTac": true,
  • "validHhgProgramCodeForLoa": true
}

application_parameters

Searches for an application parameter by name, returns nil if not found

Searches for an application parameter by name, returns nil if not found

path Parameters
parameterName
required
string <string>

Parameter Name

Responses

calendar

Validate move date selection

Utility API to determine if input date falls on weekend and/or holiday.

path Parameters
countryCode
required
string
Value: "US"

country code for context of date

date
required
string <date>

input date to determine if weekend/holiday for given country.

Responses

Response samples

Content type
application/json
{
  • "country_code": "string",
  • "country_name": "string",
  • "date": "2018-09-25",
  • "is_weekend": true,
  • "is_holiday": true,
  • "details": "string"
}